actions--create-tag's Introduction

Create Tag

This action will create a new tag via GitHub API, tagger is related to token identity. ~~Tags are signed if a GitHub App token (ghs_***) is used and will be marked as verified in the GitHub web interface.~~ Although commits get signed, if created via GitHub api, unfortunately tags are not signed by GitHub API. [As of March 2024]

The only way to create signed tags through GitHub API is to create a release (see release example below).

Example

jobs:
  example:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - run: |
          TAG_NAME=v1.0.0
          echo "TAG_NAME=${TAG_NAME}" >> $GITHUB_ENV

      - uses: qoomon/actions--create-tag@v1
        with:
          name: ${{ env.TAG_NAME }}

      - run: git push origin "${TAG_NAME}"

Inputs

inputs:
  name:
    description: 'The annotated tag name'
    required: true
  message:
    description: 'The annotated tag message'

  token:
    description: 'A GitHub access token'
    required: true
    default: ${{ github.token }}
  working-directory:
    description: 'The working directory'
    required: true
    default: '.'
  remoteName:
    description: 'The remote name to create the tag at.'
    required: true
    default: 'origin'

Create a Tag through a Release Example

jobs:
  example:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      # see https://cli.github.com/manual/gh_release_create
      - run: |
          TAG_NAME=v1.0.0
          gh release create "${TAG_NAME}" --generate-notes
        env:
          GH_TOKEN: ${{ github.token }}