update-tags-action

Easily create/update one or more Git tags in a GitHub repository.

Generally useful for moving major (v1) and minor (v1.2) tags to same commit as the latest v1.x.x tag.

This action uses itself to move its own major and minor tags.

Examples

Basic

- uses: jimeh/update-tags-action@v1
  with:
    tags: v1,v1.2

- uses: jimeh/update-tags-action@v1
  with:
    tags: |
      v1
      v1.2

With Release Please

This example uses jimeh/release-please-manifest-action, but you can just as easily use the official google-github-actions/release-please-action instead.

name: Push
on: push

jobs:
  release-please:
    runs-on: ubuntu-latest
    if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
    steps:
      - uses: jimeh/release-please-manifest-action@v1
        id: release-please
      - uses: jimeh/update-tags-action@v1
        with:
          tags: |
            v${{ steps.release-please.outputs.major }}
            v${{ steps.release-please.outputs.major }}.${{ steps.release-please.outputs.minor }}

Inputs

parameter	description	required	default
tags	List/CSV of tags to create/update.	`true`
ref	The SHA or ref to tag. Defaults to SHA of current commit.	`false`	${{ github.sha }}
parse	Version string to parse as SemVer and expose in the tags input via templating.	`false`
when_exists	What to do if the tag already exists. Must be one of 'update', 'skip', 'warn', or 'fail'.	`false`	update
when_parse_fails	What to do with non-empty `parse` input that fails to parse as a Semantic Version. Must be one of 'warn' or 'fail'.	`false`	fail
skip_prerelease	When `parse` input is pre-release version, should templated tags be skipped?	`false`	true
github_token	The GitHub token to use for authentication.	`false`	${{ github.token }}

Outputs

parameter	description
tags	List of tags that were created/updated.
created	List of tags that were created.
updated	List of tags that were updated.

4.1 KiB Raw Permalink Blame History