Automatic bump version of .NET solution by following semantic release
APACHE-2.0 License
GitHub action which bumps the library version that follows Semantic Versioning.
NOTICE: Pre-release functionality for
type=assembly
is untested and might not work as .NET versioning there does not follow semver.
Attention
Make sure you use the actions/checkout@v2
action!
Migration: Version v9 and up
Remove the 'actions/setup-node@v1' step from your action.yml file
- name: 'Setup Node.js'
uses: 'actions/setup-node@v1'
with:
node-version: 14
refactor!: drop support for Node 6
is found anywhere in any of the commit messages or descriptions the major"feat: new API"
and "feature: new API"
.Customize the messages that trigger the version bump. It must be a string, case sensitive, coma separated (optional). Example:
- name: 'Automated Version Bump'
uses: '@lagoni/gh-action-dotnet-bump@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
minor-wording: 'add,Adds,new'
major-wording: 'MAJOR,cut-major'
patch-wording: 'patch,fixes' # Providing patch-wording will override commits
# defaulting to a patch bump.
rc-wording: 'RELEASE,alpha'
Set a default version bump to use (optional - defaults to patch). Example:
- name: 'Automated Version Bump'
uses: '@lagoni/gh-action-dotnet-bump@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
default: prerelease
Set a pre-id value will building prerelease version (optional - defaults to 'rc'). Example:
- name: 'Automated Version Bump'
uses: '@lagoni/gh-action-dotnet-bump@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
default: prerelease
pre-id: 'prc'
Prefix that is used for the git tag (optional). Example:
- name: 'Automated Version Bump'
uses: '@lagoni/gh-action-dotnet-bump@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
tag-prefix: 'v'
The tag is not added to the git repository (optional). Example:
- name: 'Automated Version Bump'
uses: '@lagoni/gh-action-dotnet-bump@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
skip-tag: 'true'
No commit is made after the version is bumped (optional). Must be used in combination with skip-tag
, since if there's no commit, there's nothing to tag. Example:
- name: 'Automated Version Bump'
uses: '@lagoni/gh-action-dotnet-bump@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
skip-commit: 'true'
skip-tag: 'true'
If true, skip pushing any commits or tags created after the version bump (optional). Example:
- name: 'Automated Version Bump'
uses: '@lagoni/gh-action-dotnet-bump@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
skip-push: 'true'
Set a custom target branch to use when bumping the version. Useful in cases such as updating the version on master after a tag has been set (optional). Example:
- name: 'Automated Version Bump'
uses: '@lagoni/gh-action-dotnet-bump@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
target-branch: 'master'
Set a custom commit message for version bump commit. Useful for skipping additional workflows run on push. Example:
- name: 'Automated Version Bump'
uses: '@lagoni/gh-action-dotnet-bump@master'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
commit-message: 'CI: bumps version to {{version}} [skip ci]'