GitHub Action
Release Tag Updater
This action automatically updates "running release" major and major.minor tags and GitHub releases.
The tag to use for generating the other tags.
If not set, the action will attempt to parse it from ${{github.ref}}
.
If neither tag
is set, nor ${{github.ref}}
is a valid tag ref, the action throws an error.
Note that passing ${{github.ref}}
directly to this input will not work!
The regex that is used to match allowed tag prefixes.
Default: 'v?'
The regex that is used to match allowed tag suffixes.
Default: ''
Whether the action should fail on non-semver compatible tags. If false
, it simply writes a log messages and exists gracefully.
Default: false
Whether the major tag should be updated.
Default: true
Whether the major.minor tag should be updated.
Default: true
Whether the repository setup should be skipped (namely setting the user.name
and user.email
config parameters).
Default: false
Whether a corresponding GitHub release should be created.
Default: true
Whether to create the GitHub releases as draft.
Default: false
The title of the major release. The placeholder ${version}
is replaced by the major tag name.
Default: '${version} Major Release Track'
The body of the major release. The placeholder ${version}
is replaced by the major tag name.
Default: 'This release tracks the latest ${version} major release (${version}.x.y).'
The title of the minor release. The placeholder ${version}
is replaced by the minor tag name.
Default: '${version} Minor Release Track'
The body of the minor release. The placeholder ${version}
is replaced by the minor tag name.
Default: 'This release tracks the latest ${version} minor release (${version}.x).'
Whether to update the full release (for tag
) to mark it as latest release.
This is useful if the release for tag
should remain the "Latest Release" even though the major / minor releases tracks created by this action are actually created / updated after the initial release.
Note that if github-token
is not ${{secrets.GITHUB_TOKEN}}
but rather a personal access token (PAT) instead, this can lead to workflow run cycles if this action is run when a release is edited/updated!
Also note that since version 3.0.0 of this action, this input might not be needed since creating releases will include "make_latest": false
in the body. The action automatically checks for the latest release and only performs an update if needed.
Default: false
The token with which to authenticate against GitHub. Only required if releases should be created. Can also be set to ${{secrets.GITHUB_TOKEN}}
.
Default: ${{github.token}}
Use the following snippet to create a major and minor release for the tag 1.2.3
:
uses: sersoft-gmbh/running-release-tags-action@v3
with:
tag: 1.2.3