Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
tag

GitHub Action

Release Tag Updater

v2.1.0

Release Tag Updater

tag

Release Tag Updater

A GitHub action that automatically updates "running release" major and major.minor tags

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Release Tag Updater

uses: sersoft-gmbh/running-release-tags-action@v2.1.0

Learn more about this action in sersoft-gmbh/running-release-tags-action

Choose a version

Release Tag Updater

Tests

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

update-full-release

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 releases is edited/updated!
Default: false

github-token

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}}

Example Usage

Use the following snippet to create a major and minor release for the tag 1.2.3:

uses: sersoft-gmbh/running-release-tags-action@v2
with:
  tag: 1.2.3