This template can be used to calculate a release or pre-release version.
This action relies on git history in order to determine the next version. This means the actions-checkout step should be added before this action and a fetch-depth: 0 needs to be set as an argument in order to fetch all history for branches and tags. If fetch-depth: 0 is not set, the action will have no tags to compare and returns 1.0.0 as the next version.
You can control whether the action will generate a release or pre-release next version with the calculate-prerelease-version flag. The pre-release versions are intended for use with branches and a branch name is required to generate one.
- Release version format:
major.minor.patch(1.0.0) - Pre-release version format:
major.minor.patch-<cleaned-branch-name>.<formated-date>(0.1.0-my-branch.210907164247)- The action will clean the provided branch name. It only accepts
a-z, A-Z, 0-9and-, any other character will be replaced with-. - If the branch name includes
refs/heads/that will be removed as well.
- The action will clean the provided branch name. It only accepts
If a previous release (tag) is found, the action examines the commit messages to determine whether the next version should be a major, minor or patch increment. For pre-release versions the commits on the current branch are used, and for release versions the commits between the last tag and HEAD are used.
The action will increment the major version if it identifies any of the following patterns in the commit body or notes:
| Pattern | Examples |
|---|---|
/\+semver:\s*(breaking|major)/i |
+semver:breaking, +semver:major |
/BREAKING CHANGES?:?/ |
BREAKING CHANGE:, BREAKING CHANGES |
The action will increment the minor version if it identifies any of the following patterns in the commit body or notes:
| Pattern | Examples |
|---|---|
/\+semver:\s*(feature|minor)/i |
+semver:feature, +semver:minor |
/feat\([^)]*\):\s/ |
feat(area): something, feat(): something |
/feature\([^)]*\):\s/ |
feature(area): something, feature(): something |
/^feat:\s.+/m |
feat: something (at the beginning of a line) |
/^feature:\s.+/m |
feature: something (at the beginning of a line) |
If none of the previous patterns match, the action will increment the patch version.
| Parameter | Is Required | Default | Description |
|---|---|---|---|
tag-prefix |
false | v |
By default the action strips the prefixes off, but any value provided here will be prepended to the next calculated version. GitHub indicates it is common practice to prefix your version names with the letter v (which is the default). If you do not want a prefix use tag-prefix: none. |
fallback-to-no-prefix-search |
false | true |
Flag indicating whether it should fallback to a prefix-less search if no tags are found with the current prefix. Helpful when starting to use prefixes with tags. Accepted values: true|false. |
calculate-prerelease-version |
false | false |
Flag indicating whether to calculate a pre-release version rather than a release version. Accepts: true|false. |
branch-name |
Required whencalculate-prerelease-version: true |
N/A | The name of the branch the next pre-release version is being generated for. Required when calculating the pre-release version. |
default-release-type |
false | major |
The default release type that should be used when no tags are detected. Defaults to major. Accepted values: major|minor|patch. |
Each of the outputs are available as environment variables and as action outputs.
| Output | Description |
|---|---|
NEXT_VERSION |
The next major.minor.patch version |
NEXT_VERSION_NO_PREFIX |
The next major.minor.patch version without the tag prefix |
NEXT_MINOR_VERSION |
The next major.minor version |
NEXT_MINOR_VERSION_NO_PREFIX |
The next major.minor version without the tag prefix |
NEXT_MAJOR_VERSION |
The next major version |
NEXT_MAJOR_VERSION_NO_PREFIX |
The next major version without the tag prefix |
NEXT_VERSION_SHA |
The SHA of the next version as an environment variable |
PRIOR_VERSION |
The previous major.minor.patch version |
PRIOR_VERSION_NO_PREFIX |
The previous major.minor.patch version without the tag prefix |
NEXT_RELEASE_VERSION |
The next major.minor.patch release version. This version will not contain the branch when calculating a pre-release version. |
NEXT_RELEASE_VERSON_NO_PREFIX |
The next major.minor.patch version without the tag prefix. This version will not contain the branch when calculating a pre-release version. |
- The
create-refinput was removed- This input has been deprecated for a while. We recommend replacing this functionality with the
[im-open/create-release]action.
- This input has been deprecated for a while. We recommend replacing this functionality with the
- The
github-tokeninput was removed- This was only needed to create a ref on the repository so it is no longer needed.
- The
NEXT_VERSION_SHAoutput was removed- Workflows can use the value that git-version-lite outputted directly.
- For
pull_requestworkflow triggers the value wasgithub.event.pull_request.head.sha. - For all other workflow triggers the value was
github.sha
on:
pull_request:
jobs:
get-prerelease-version:
runs-on: ubuntu-20.04
outputs:
NEXT_VERSION: ${{ steps.get-version.outputs.NEXT_VERSION }}
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0 # Includes all history for all branches and tags
- id: get-version
# You may also reference just the major version.
uses: im-open/git-version-lite@v3.2.0
with:
calculate-prerelease-version: true
branch-name: ${{ github.head_ref }} # github.head_ref works when the trigger is pull_request
tag-prefix: v # Prepend a v to any calculated release/pre-release version
fallback-to-no-prefix-search: true # Set to true can be helpful when starting to add tag prefixes
default-release-type: major # If no tags are found, default to doing a major increment
- run: |
echo "The next version is ${{ env.NEXT_VERSION }}"
echo "The next version without the prefix is ${{ steps.get-version.outputs.NEXT_VERSION_NO_PREFIX }}"
When creating PRs, please review the following guidelines:
- The action code does not contain sensitive information.
- At least one of the commit messages contains the appropriate
+semver:keywords listed under Incrementing the Version for major and minor increments. - The action has been recompiled. See Recompiling Manually for details.
- The README.md has been updated with the latest version of the action. See Updating the README.md for details.
- Any tests in the build-and-review-pr workflow are passing
This repo uses git-version-lite in its workflows to examine commit messages to determine whether to perform a major, minor or patch increment on merge if source code changes have been made. The following table provides the fragment that should be included in a commit message to active different increment strategies.
| Increment Type | Commit Message Fragment |
|---|---|
| major | +semver:breaking |
| major | +semver:major |
| minor | +semver:feature |
| minor | +semver:minor |
| patch | default increment type, no comment needed |
The files and directories that are considered source code are listed in the files-with-code and dirs-with-code arguments in both the build-and-review-pr and increment-version-on-merge workflows.
If a PR contains source code changes, the README.md should be updated with the latest action version and the action should be recompiled. The build-and-review-pr workflow will ensure these steps are performed when they are required. The workflow will provide instructions for completing these steps if the PR Author does not initially complete them.
If a PR consists solely of non-source code changes like changes to the README.md or workflows under ./.github/workflows, version updates and recompiles do not need to be performed.
This command utilizes esbuild to bundle the action and its dependencies into a single file located in the dist folder. If changes are made to the action's source code, the action must be recompiled by running the following command:
# Installs dependencies and bundles the code
npm run buildIf changes are made to the action's source code, the usage examples section of this file should be updated with the next version of the action. Each instance of this action should be updated. This helps users know what the latest tag is without having to navigate to the Tags page of the repository. See Incrementing the Version for details on how to determine what the next version will be or consult the first workflow run for the PR which will also calculate the next version.
The build-and-review-pr workflow includes tests which are linked to a status check. That status check needs to succeed before a PR is merged to the default branch. When a PR comes from a branch, the workflow has access to secrets which are required to run the tests successfully.
When a PR comes from a fork, the workflow cannot access any secrets, so the tests won't have the necessary permissions to run. When a PR comes from a fork, the changes should be reviewed, then merged into an intermediate branch by repository owners so tests can be run against the PR changes. Once the tests have passed, changes can be merged into the default branch.
This project has adopted the im-open's Code of Conduct.
Copyright © 2023, Extend Health, LLC. Code released under the MIT license.