Release Tag Updater

This action automatically updates "running release" major and major.minor tags and GitHub releases.

Inputs

tag

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!

prefix-regex

The regex that is used to match allowed tag prefixes.
Default: 'v?'

suffix-regex

The regex that is used to match allowed tag suffixes.
Default: ''

fail-on-non-semver-tag

Whether the action should fail on non-semver compatible tags. If false, it simply writes a log messages and exists gracefully.
Default: false

update-major

Whether the major tag should be updated.
Default: true

update-minor

Whether the major.minor tag should be updated.
Default: true

skip-repo-setup

Whether the repository setup should be skipped (namely setting the user.name and user.email config parameters).
Default: false

create-release

Whether a corresponding GitHub release should be created.
Default: true

create-release-as-draft:

Whether to create the github releases as draft.
Default: false

major-release-title

The title of the major release. The placeholder ${version} is replaced by the major tag name.
Default: '${version} Major Release Track'

major-release-body

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).'

minor-release-title

The title of the minor release. The placeholder ${version} is replaced by the minor tag name.
Default: '${version} Minor Release Track'

minor-release-body

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).'

github-token

The token with which to authenticate against GitHub. Only required if releases should be created. Can be set to ${{secrets.GITHUB_TOKEN}}.

Example Usage

Use the following snippet in a Swift package repository to generate jazzy docs for all products of your Swift package:

uses: sersoft-gmbh/running-release-tags-action@v1
with:
  tag: 1.2.3
  github-token: ${{secrets.GITHUB_TOKEN}}