step-security/GitHub Tag
Bump and push git tag on merge
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| github_token | Required for permission to tag the repo. | yes | — |
| default_bump | Which type of bump to use when none explicitly provided when commiting to a release branch (default: `patch`). | no | patch |
| default_prerelease_bump | Which type of bump to use when none explicitly provided when commiting to a prerelease branch (default: `prerelease`). | no | prerelease |
| tag_prefix | A prefix to the tag name (default: `v`). | no | v |
| append_to_pre_release_tag | A suffix to a pre-release tag name (default: `<branch>`). | no | — |
| custom_tag | Custom tag name. If specified, it overrides bump settings. | no | — |
| custom_release_rules | Comma separated list of release rules. Format: `<keyword>:<release_type>`. Example: `hotfix:patch,pre-feat:preminor`. | no | — |
| release_branches | Comma separated list of branches (bash reg exp accepted) that will generate the release tags. Other branches and pull-requests generate versions postfixed with the commit hash and do not generate any tag. Examples: `master` or `.*` or `release.*,hotfix.*,master`... | no | master,main |
| pre_release_branches | Comma separated list of branches (bash reg exp accepted) that will generate pre-release tags. | no | — |
| commit_sha | The commit SHA value to add the tag. If specified, it uses this value instead GITHUB_SHA. It could be useful when a previous step merged a branch into github.ref. | no | — |
| create_annotated_tag | Boolean to create an annotated tag rather than lightweight. | no | false |
| fetch_all_tags | Boolean to fetch all tags for a repo (if false, only the last 100 will be fetched). | no | false |
| dry_run | Do not perform tagging, just calculate next version and changelog, then exit. | no | false |
Outputs
| name | description |
|---|---|
| new_tag | Generated tag |
| new_version | Generated tag without the prefix |
| previous_tag | Previous tag (or `0.0.0`) |
| previous_version | The value of the previous tag (or 0.0.0 if none) without the prefix. Note that if custom_tag is set, this will be undefined. |
| release_type | The computed release type (`major`, `minor`, `patch` or `custom` - can be prefixed with `pre`) |
| changelog | The conventional changelog since the previous tag |