Repository files navigation

Please star this repository if you like the application, it will help more people see it. Thank you!

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

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

Also, there are 5 postfixes for environment variables listed above:

• '_MAJOR'
• '_MINOR'
• '_PATCH'
• '_PRERELEASE'
• '_BUILDMETADATA'

They contain corresponding version fragments, so for release version5.0.3 environment / output variableRELEASE_VERSION_PATCH will contain3.

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

By default, the action increments prerelease version. Basically it picks a number in a substring starting withalpha|beta|rc + a number. It also possible to notate all caps or starting with a capital letter (ALPHA, alpha and Alphaare 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. Youcan force action increment a specific version fragment you like by configuringNext 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 Gradlerelease plugin needs at least one parameter specified (release.newVersion). This pipeline provides gradle bothnecessary versions: which to release and which to commit back into the release branch.

name:Releaseon:push:branches:      -'master'jobs:build:runs-on:ubuntu-lateststeps:      -name:Checkout repositoryuses:actions/checkout@v3      -name:Set up JDK 1.8uses:actions/setup-java@v3with:distribution:'temurin'java-version:'8'      -name:Generate versionsuses:HardNorth/github-version-generate@v1.4.0with:version-source:fileversion-file:gradle.propertiesversion-file-extraction-pattern:'(?<=version=).+'      -name:Grant execute permission for gradlewrun:chmod +x gradlew      -name:Release with Gradleid:releaserun:|          ./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:releaseon:push:branches:      -masterenv:VERSION_FILE_NAME:'VERSION'VERSION_BUMP_FILE:'version_fragment'jobs:calculate-version:runs-on:ubuntu-lateststeps:      -name:Checkout repositoryuses:actions/checkout@v3      -name:Get version fragment to bumpid:getVersionFragmentrun:|          read -r versionFragment < ${{ env.VERSION_BUMP_FILE }}          echo "'$versionFragment' version will be incremented"          echo "::set-env name=VERSION_FRAGMENT::${versionFragment}"      -name:Generate versionsuses:HardNorth/github-version-generate@v1.4.0with:version-source:fileversion-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 theversion_fragment file will be "minor" then minor version will be incremented respectively.

Built-in data extraction mechanism.

Example:

data-extract:truedata-extract-name:'first_variable'data-extract-paths:'/path/to/file'data-extract-patterns:'/(?<=variable.name=).+/i'

There are several use cases depending on RegEx format and flags:

• RegEx Match only - As on example, above. Variable name in 'data-extract-name' parameter will be used 'as is',variable value will be set on matched text. Extraction will fail if 'data-extract-name' is not set.
• One group - Variable name in 'data-extract-name' parameter will be used 'as is', variable value will be set ongroup value. Extraction will fail if 'data-extract-name' is not set.
• Two or more groups - If 'data-extract-name' value is set then the first group will be used as value, and othergroups will be ignored, if it's not set, then the first group will used as variable name and the second groupwill be used as value.
• Multiple match (multiple RegEx, 'g' flag in RegEx is set, etc) - If 'data-extract-name' value is set the actionwill extract all RegEx matches and export variables with underscore and variable index as suffix, except thefirst one.E.G.: first_variable -> FIRST_VARIABLE, FIRST_VARIABLE_1, etc; If 'data-extract-name' value is not set thentwo groups in every RegEx is a requirement, the first group will used as variable name and the second group willbe used as value. If multiple files have the same variable names, output values will be overwritten with thelatter matches.

Variable name convert rules:

• Spaces and symbols '-', even multiple in a row, will be converted to single symbol '_';
• Other special characters except digits and letters will be cut off;
• The variable name will be converted to upper case.

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

Apache License Version 2.0 -repo link.

The action was created byVadzim HushchanskouatHardNorth/github-version-generate