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: jasonamyers/github-bumpversion-action@v1.0.5
        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 repository.
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_ver - The value of the newly created tag.
old_ver - The value of the previous tag.
part - The part of version which was bumped.

Note: This action creates a lightweight tag.

Bumping

Manual Bumping: Any commit message that includes #major, #minor, or #patch will trigger the respective version bump. If two or more are present, the highest-ranking one will take precedence.

Automatic Bumping: If no #major, #minor or #patch tag is contained in the commit messages, it will bump whichever DEFAULT_BUMP is set to (which is patch by default).

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

Workflow

Add this action to your repository
Setup a .bumpversion.cfg file in the root of your repository
- Note: See the .bumpversion.cfg in this repository for an example
Commit some changes
Either push to master or open a PR
On push (or merge) to master, the action will:
- Bump current tag with patch version unless any commit message contains #major or #minor
- Bump the version of any files specified in the .bumpversion.cfg file

Credits

anotherNick/github-tag-action - I used this repository extensively as a base for this project