Action-Tagger

A lightning fast autotagger for semver-tagging. It helps you to stay on top of your release management and release your code quickly and often through GitHub's tag-based release functions just by pushing to your repository.

This action scans your commit messages for fixed issues and semver changes. Use #major, #minor, or #patch tags in your commit messages and autotagger will increase your version tags accordingly. If a commit message fixes an issue (using fixes #issuenbr style messages), then action-tagger will check wether the corresponding issue was labled as enhancement that triggers a minor release, or a bug fix that will be treated as a patch. action-tagger also supports prereleases for non-release branches and custom tags.

This action based on phish108/autotag-action, but is written completely in typescript.

action-tagger uses Octokit for tagging and does not depend on checking out the repository.

Inputs

github-token

Required The github token for accessing the repository.

dry-run

Optional If the value is not FALSE (case insensitive), the action performs all steps, but omit the actual tagging. (Default: FALSE).

This input is useful if the release version has to be known for other steps before actually tagging the final commit. It is very handy if a build or cleanup steps will extend the initial commit or merge request.

bump

Optional semver bumping. Valid values are major, minor or patch (Default: patch)

with-v

Optional If not FALSE (case insensitive), then the action adds a v to prefix the tag. (Default: FALSE)

branch

Optional Sets a branch to perform the action on. This is useful if the triggering action's branch is different to the final action.

This input is useful if subsequent steps manipulate a different branch, which should get tagged. This is useful when tagging of merge requests.

release-branch

Optional A comma-separated list of branch names or regular expressions. (Default: master)

tag

Optional Custom tag to be added to the current SHA. Will not perform any version bumping, but adds the provided tag.

issue-labels

Optional A comma-separated list of issue labels that changes the bump level from patch to minor (Default: enhancement).

Outputs

tag

The previous latest tag before this action ran. This output is unavailable, when the tag input is used.

new-tag

The latest tag after this action ran.

Example Usage

Minimal call

name: Auto.Tag

on: 
- push

jobs:
  tag:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: 
        - 12
    steps: 
    - uses: empayre/action-tagger@v1
      with:
        github-token: ${{ secrets.GITHUB_TOKEN}}

More advanced call as part of a test pipeline.

name: Node.CI

on: 
- push

jobs:
  build:
    runs-on: ubuntu-latest

    strategy:
      matrix:
        node-version: 
        - 12

    steps:
    - run: echo 00010
    - uses: actions/checkout@v2
    - name: Use Node.js ${{ matrix.node-version }}
      uses: actions/setup-node@v1
      with:
        node-version: ${{ matrix.node-version }}
    - run: npm ci
    - run: npm test
      env:
        CI: "true"
    - uses: empayre/action-tagger@v1
      with:
        github-token: ${{ secrets.GITHUB_TOKEN}}
        with-v: "true"

more complex scenario in merge requests

name: Pull Request CI

on: 
  pull_request:
    branches: 
      - master

jobs:
  lint:
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node-version: 
        - 12.x

    steps:
    - uses: actions/checkout@v2
    - uses: actions/setup-node@v1
      with:
        node-version: ${{ matrix.node-version }}
    - run: npm ci
    - run: npm run lint

  build:
    needs: lint
    runs-on: ${{ matrix.os }}

    strategy:
      matrix:
        node-version: 
        - 12.x
        - 13.x
        os:
        - ubuntu-latest
        - macos-latest
        - windows-latest

    steps:
    - uses: actions/checkout@v2
    - name: Use Node.js ${{ matrix.node-version }}
      uses: actions/setup-node@v1
      with:
        node-version: ${{ matrix.node-version }}
    - run: npm ci
    - run: npm test
      env:
        CI: true

  merge: 
    needs: build
    if: github.actor == 'phish108' ||  startsWith(github.actor, 'dependabot')
    
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2
    - name: automerge
      uses: "pascalgn/automerge-action@5ad9f38505afff96c6ad2d1c1bf2775135a7d309"
      env:
        GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
        MERGE_LABELS: ""

  release: 
    needs: merge
    if: github.actor == 'phish108' || startsWith(github.actor, 'dependabot')

    runs-on: ubuntu-latest

    steps:
      - id: contributor 
        run: echo ::set-output name=release::minor
        if: github.actor == 'phish108'

      - id: bot
        run: echo ::set-output name=release::patch
        if: startsWith(github.actor, 'dependabot')

      - uses: actions/checkout@v2
        with:
          ref: master

      - run: |
          git config --local user.email "action@github.com"
          git config --local user.name "GitHub Action"
  
      - uses: empayre/action-tagger@v1
        id: tagger
        env:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          branch: master
          bump: ${{ steps.contributor.outputs.release || steps.bot.outputs.release }}
          dry-run: 'true'

      - run: | 
          npm --no-git-tag-version --allow-same-version version "${{ steps.tagger.outputs.new-tag }}"
          git commit -m "version bump to ${{ steps.tagger.outputs.new-tag }}" -a

      - name: Push changes
        uses: ad-m/github-push-action@master
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}

      - uses: empayre/action-tagger@v1
        env:
          github-token: ${{ secrets.GITHUB_TOKEN }}
          branch: master
          bump: ${{ steps.contributor.outputs.release || steps.bot.outputs.release }}
          with-v: true

More advanced usage

The tag input allows to use a custom tag for tagging. This is useful when generating or applying tags.

The issue-labels input allows to define issues labels that should be considered as minor versions (API extensions). The default is the enhancement label. All other labels are treated as patches that do not change the API.