semver-bump-action

README

Semver Bump Action

Automatically bump the given semver version up.

Inputs

current-version

Required - The semantic version (semver) that needs to be bumped. For example, 1.2.3.

bump-level

Required - Specifies the semver bump level. Allowed values:

• major - Increments the major version (e.g., 1.2.3 to 2.0.0).
• minor - Increments the minor version (e.g., 1.2.3 to 1.3.0).
• patch - Increments the patch version (e.g., 1.2.3 to 1.2.4).
• premajor - Creates a premajor prerelease (e.g., 1.2.3 to 2.0.0-alpha.0).
• preminor - Creates a preminor prerelease (e.g., 1.2.3 to 1.3.0-alpha.0).
• prepatch - Creates a prepatch prerelease (e.g., 1.2.3 to 1.2.4-alpha.0).
• prerelease - Increments an existing prerelease or creates a new one (e.g., 1.2.3-alpha.0 to 1.2.3-alpha.1).

prerelease-tag

Required - The tag to use for prereleases (e.g., alpha, beta). For example, specifying alpha in combination with bump-level as prerelease will result in versions like 1.2.3-alpha.0.

Outputs

new_version

The bumped semantic version. For example, if current-version is 1.2.3 and bump-level is minor, new_version will be 1.3.0.

Workflow Usage

Add the following step to your GitHub Actions Workflow:

name: Demo Workflow

on:
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: Get Latest Tag
        id: current
        run: |
          latest_tag="v1.0.0"
          echo "latest_tag=$latest_tag" >> $GITHUB_ENV

      - name: Bump Minor Version
        id: bump
        uses: cbrgm/semver-bump-action@main
        with:
          current-version: ${{ env.latest_tag }}
          bump-level: minor

      - name: Output
        run: |
          new_tag=${{ steps.bump.outputs.new_version }}
          echo $new_tag
          echo $new_tag

Example: Bump + Publish Minor Version Tag

name: Tag Release

on:
  workflow_dispatch:

jobs:
  build:
    runs-on: ubuntu-latest
    steps:

      - name: Checkout
        uses: actions/checkout@v4

      - name: Get Latest Tag
        id: current
        run: |
          latest_tag=$(git describe --tags --abbrev=0)
          echo "current version is: $latest_tag"
          echo "latest_tag=$latest_tag" >> $GITHUB_ENV

      - name: Bump Minor Version
        id: bump
        uses: cbrgm/semver-bump-action@main
        with:
          current-version: ${{ env.latest_tag }}
          bump-level: minor

      - name: Push Git Tag
        run: |
          git fetch --tags
          latest_tag=$(git describe --tags --abbrev=0)
          new_tag=${{ steps.bump.outputs.new_version }}
          if [[ $(git rev-list $latest_tag..HEAD --count) -gt 0 ]]; then
            git config user.name "GitHub Actions"
            git config user.email "github-actions@users.noreply.github.com"
            git tag $new_tag
            git push origin $new_tag
          else
            echo "No new commits since last tag. Skipping tag push."
          fi

Local Development

You can build this action from source using Go:

make build

Contributing & License

Feel free to submit changes! See the Contributing Guide. This project is open-source and is developed under the terms of the Apache 2.0 License.