ntltd/Release Generator
Generate a Github release with parsed commits into a given Markdown template
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
- Runtime
- Deprecated runtime
Inputs
| name | description | required | default |
|---|---|---|---|
| app | The name of the app involved in the release (monorepo mode). Creates tag and render commits for a specific scope, based on the given app name. Scopes from commits are analyzed for commits that follow the Angular commit style. e.g. `<type>(<app>): my commit title` or `(<app>): my commit title` | no | — |
| baseTag | The tag that will be used as base for git commit comparison, instead of the automatic detection of latest published release. The commits will be formatted into a Markdown list and replaced into the `$CHANGES` variable for the given `templatePath` template file. | no | — |
| bumpProtection | Propose PATCH version bumps whenever a MINOR or MAJOR is detected in a diff that had a previous MINOR or MAJOR bump. | no | false |
| draft | Publish release draft | no | true |
| prerelease | Mark release as prerelease when creating | no | true |
| pushTag | Creates and pushes the automatic calculated tag before creating the release. Useful if you want the action to handle tags for you when publishing drafts. By default, a release draft won't create the tag, which only happens when it is published. | no | false |
| releaseName | The release title | no | — |
| releaseTag | The git tag that will be linked to the release. If undefined, it will detect the latest tag and bump it. | no | — |
| taskBaseUrl | The base url to append for a detected task (do not set a trailing `/`). By default, it will create a url based on your Github organization. (e.g. https://myorg.atlassian.net/browse) | no | — |
| taskPrefix | The prefix that identifies task ids in the commits | no | JIRA- |
| templatePath | The path for the Markdown template that will be used to create the release body, relative to `.github/`. | yes | — |
| token | The token to access Github's API | yes | — |
Outputs
| name | description |
|---|---|
| changes | A JSON array with the list of commit sha that are involved in the release |
| new_tag | The newly created tag that will reference the release |
| new_version | The newly created version that belongs to the tag |
| html_url | The browser url linking to Github's release |
| tasks | A JSON array with the list of project management tasks involved in the release |
| previous_tag | The previously detected tag that was bumped by the action |
| previous_version | The previously detected version that was bumped by the action |
| pull_requests | A JSON array with the list of Github pull requests involved in the release |
| release_id | The release id given by Github's API |
| upload_url | The url used for uploading release artifacts |