A GitHub action for reading, bumping, generating, formatting applications versions in release pipelines. Outputs three environment variables:

• 'env.CURRENT_VERSION' - a current, extracted version of application without any changes
• 'env.RELEASE_VERSION' - a generated release version with SNAPSHOT suffix removed by default
• 'env.NEXT_VERSION' - a new version supposed to put into version source file instead of CURRENT_VERSION

The action uses so-called "Semantic version" system, please check out the specification first to avoid misunderstanding and misuses.

By default, the action increments prerelease version. Basically it picks a number in a substring starting with alpha|beta|rc + a number. It also possible to notate all caps or starting with a capital letter (ALPHA, alpha and Alpha are OK).

E.G.:

• TESTNG7-BETA-7-SNAPSHOT → TESTNG7-BETA-8-SNAPSHOT
• rc1 → rc2
• TESTNG6-Alpha1 → Alpha2

Here are some prerelease fragments and a regex which is used to extract the prerelease number: https://regex101.com/r/O5GUdN/2

If there is no regex match in prerelease section the patch version fragment will be incremented. You can force action increment a specific version fragment you like by configuring Next version parameters. If any of such parameters was specified the default behavior will be ignored.

To use the action introduce it into your job steps of a github actions workflow.

A pretty simple pipeline which launches a release task. To update development version back in a release branch Gradle release plugin needs at least one parameter specified (release.newVersion). This pipeline provides gradle both necessary versions: which to release and which to commit back into the release branch.

name: Release

on:
  push:
    branches:
    - 'master'

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - uses: actions/checkout@v2

    - name: Set up JDK 1.8
      uses: actions/setup-java@v1
      with:
        java-version: 1.8

    - name: Generate versions
      uses: HardNorth/[email protected]
      with:
        version-source: file
        version-file: gradle.properties
        version-file-extraction-pattern: '(?<=version=).+'

    - name: Grant execute permission for gradlew
      run: chmod +x gradlew

    - name: Release with Gradle
      id: release
      run: |
        ./gradlew release -Prelease.useAutomaticVersion=true \
        -Prelease.releaseVersion=${{ env.RELEASE_VERSION }} \
        -Prelease.newVersion=${{ env.NEXT_VERSION }}

The pipeline demonstrates how you can control which version fragment to increment by a file with a specific keyword:

name: release

on:
  push:
    branches:
      - master

env:
  VERSION_FILE_NAME: 'VERSION'
  VERSION_BUMP_FILE: 'version_fragment'
jobs:
  calculate-version:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout repository
        uses: actions/checkout@v2

      - name: Get version fragment to bump
        id: getVersionFragment
        run: |
          read -r versionFragment < ${{ env.VERSION_BUMP_FILE }}
          echo "'$versionFragment' version will be incremented"
          echo "::set-env name=VERSION_FRAGMENT::${versionFragment}"

      - name: Generate versions
        uses: HardNorth/[email protected]
        with:
          version-source: file
          version-file: ${{ env.VERSION_FILE_NAME }}
          next-version-increment-patch: ${{ contains(env.VERSION_FRAGMENT, 'patch') }}
          next-version-increment-minor: ${{ contains(env.VERSION_FRAGMENT, 'minor') }}
          next-version-increment-major: ${{ contains(env.VERSION_FRAGMENT, 'major') }}

If the content of the version_fragment file will be "minor" then minor version will be incremented respectively.

• The action builds using itself, check out Release pipeline.
• Report Portal uses the action to build its agents. E.G.: JUnit

Apache License Version 2.0 - repo link.

The action was created by Vadzim Hushchanskou at HardNorth/github-version-generate