GitHub bumpversion Action

A Github Action to use the bumpversion application to bump and tag branches

Usage

name: Bump version
on:
  push:
    branches:
      - master
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - name: Bump version and push tag
        uses: zefr-inc/github-bumpversion-action
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
      - name: Push changes
        uses: ad-m/github-push-action@master
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          tags: true

Options

Environment Variables

• GITHUB_TOKEN (required) - Required for permission to tag the repo.
• DEFAULT_BUMP (optional) - Which type of bump to use when none explicitly provided (default: minor).
• SOURCE (optional) - Operate on a relative path under $GITHUB_WORKSPACE.
• DRY_RUN (optional) - Determine the next version without tagging the branch. The workflow can use the outputs new_tag and tag in subsequent steps. Possible values are true and false (default).
• NEW_VERSION (optional) - New version that should be in the files.

Outputs

• new_tag - The value of the newly created tag.
• old_tag - The value of the previous tag.
• part - The part of version which was bumped.

Bumping

To set the bump type simply add [bumpVersion: xxx] to your PR title with xxx being one of the following:

• major
• minor
• patch
• skip

Note: This action will not bump the tag if the HEAD commit has already been tagged.

Workflow

• Add this action to your repo
• Setup a .bumpversion.cfg file in the root of your repo
• Commit some changes
• Open a PR and set bumpVersion in the title
• On merge to master, the action will:
  • Bump current tag
  • Bump the version of any files specified in the .bumpversion.cfg file

Credits

github-bumpversion-action - Reference action