taiki-e/Create GitHub Releases based on changelog
GitHub Action for creating GitHub Releases based on changelog
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| changelog | Path to changelog (variables `$tag`, `$version`, `$prefix`, and any string) | no | — |
| allow-missing-changelog | Create the release even if the changelog entry corresponding to the version is missing. The default value of the changelog will be an empty string. | no | false |
| title | Format of title (variables `$tag`, `$version`, `$prefix`, and any string) | no | $tag |
| draft | Create a draft release ('true' or 'false') | no | false |
| branch | Reject releases from commits not contained in branches that match the specified pattern (regular expression) | no | — |
| prefix | An optional pattern that matches a prefix for the release tag, before the version number. If a prefix is provided, an optional '-' character is permitted (but not required) between the prefix and the version number. For example, the tags 'my-crate-v0.1.2' and 'my-crate0.1.0' both have the prefix 'my-crate'. This is interpreted as a bash-style regular expression, so it may be used to match multiple prefix strings. Therefore, literal characters that are part of bash's regular expression syntax, such as `$`, `^`, `[`, `]`, `{`, `}`, `(`, `)`, and `|` must be escaped if they occur in the prefix pattern. If a prefix pattern is provided, the portion of the tag that matched the prefix can be interpolated into `title` and `changelog` via the `$prefix` variable. | no | "" |
| token | GitHub token for creating GitHub Releases. If not set this option, the GITHUB_TOKEN environment variable will be used. If not set both this option and the GITHUB_TOKEN environment variable, github.token will be used. | no | — |
| ref | Fully-formed tag ref for this release. If not set this option, the GITHUB_REF environment variable (automatically set by GitHub Actions) will be used. | no | — |
Outputs
| name | description |
|---|---|
| computed-prefix | The computed prefix, including '-' and 'v' if found. |
| version | The version number extracted from the tag. The tag name is a concatenation of computed-prefix and version. |