Introduction
This plugin can be used to determine the next release version based on previous tags and the commit messages used.
It can also be used to get the current version.
The commit message format used is conventional commits.
Getting started
This plugin can be used in a pipeline in a stage or the environment block. Some examples of this in use are:
In the environment block
pipeline {
agent any
environment {
CURRENT_VERSION = currentVersion()
NEXT_VERSION = nextVersion()
}
stages {
stage('Hello') {
steps {
echo "current vesion = ${CURRENT_VERSION}"
echo "next version = ${NEXT_VERSION}"
}
}
}
}
In a scripted Pipeline
def NEXT_VERSION
node {
stage('Get next version ...') {
CURRENT_VERSION=currentVersion()
echo "Current version: $CURRENT_VERSION"
NEXT_VERSION=nextVersion()
echo "Next version : $NEXT_VERSION"
}
stage ('Release') {
sh "mvn release:prepare -DreleaseVersion=$NEXT_VERSION"
sh 'mvn release:perform'
}
}
Using Optional Parameters
The plugin provides provision to use optional parameters for support of build metadata, pre-release information, settings the start tag, etc.
Build Metadata
buildMetadata
an optional parameter can be added as follows:
pipeline {
agent any
environment {
NEXT_VERSION = nextVersion(buildMetadata: "$env.BUILD_NUMBER")
}
stages {
stage('Hello') {
steps {
echo "next version = ${NEXT_VERSION}"
}
}
}
}
Assuming next version is 1.1.0
. The pipeline will output :next version = 1.1.0+001
Use with prerelease information
For a 1.0.0
existing version the following code :
pipeline {
agent any
environment {
NEXT_VERSION = nextVersion(preRelease: 'alpha')
}
stages {
stage('Hello') {
steps {
echo "next version = ${NEXT_VERSION}"
}
}
}
}
Will display :next version = 1.1.0-alpha
Prerelease possible combinations
There are three options to manipulate the prerelease option :
- the name of the prerelease ➡️
preRelease
- keep the existing prerelease (default false) ➡️
preservePrelease
- increment the existing prerelease (default false) ➡️
incrementPreRelease
The table below resume the combined use of these options and the result:
current version | Breaking change commit msg | Feature commit msg | Other or empty commit msg | prerelease | preservePreRelease | incrementPreRelease | Output |
---|---|---|---|---|---|---|---|
0.1.0 | X | - | - | - | - | - | 1.0.0 |
0.1.0 | - | X | - | - | - | - | 0.2.0 |
0.1.0 | - | - | X | - | - | - | 0.1.1 |
0.1.0 | X | - | - | alpha | - | - | 1.0.0-alpha |
0.1.0 | - | X | - | alpha | - | - | 0.2.0-alpha |
0.1.0 | - | - | X | alpha | - | - | 0.1.1-alpha |
1.0.0-alpha | - | - | - | - | - | - | 1.0.0 |
0.1.0-alpha | - | - | - | - | - | - | 0.1.0 |
0.1.1-alpha | - | - | - | - | - | - | 0.1.1 |
0.1.0-alpha | X | - | - | - | X | - | 1.0.0-alpha |
0.1.0-alpha | - | X | - | - | X | - | 0.2.0-alpha |
0.1.0-alpha | - | - | X | - | X | - | 0.1.1-alpha |
0.1.0-alpha | - | - | X | - | X | X | 0.1.1-alpha.1 |
0.1.0-alpha | X | - | - | beta | - | - | 1.0.0-beta |
0.1.0-alpha | - | X | - | beta | - | - | 0.2.0-beta |
0.1.0-alpha | - | - | X | beta | - | - | 0.1.1-beta |
Write next version in the configuration file (pom.xml, package.json)
The optional parameter writeVersion
allow writing back to the file the next calculated version.
The supported configurations files :
- pom.xml (Maven) : need the Maven CLI in the path,
- package.json (NPM) : need the Npm CLI in the path,
- chart.yaml (Helm),
- build.gradle / gradle.properties (Gradle),
- setup.py / setup.cfg / pyproject.toml (Python),
- go.mod (GoLang).
Example of use : With a project with a package.json as follows :
{
"name": "conventional-commits-plugin-example-npm",
"version": "1.0.0",
"description": "Npm example project"
}
The following pipeline with a commit with a commit message like feat: my cool feature:
pipeline {
agent any
environment {
NEXT_VERSION = nextVersion(writeVersion: true)
}
stages {
stage('Hello') {
steps {
echo "next version = ${NEXT_VERSION}"
}
}
}
}
Will update the package.json as follows :
{
"name": "conventional-commits-plugin-example-npm",
"version": "1.1.0",
"description": "Npm example project"
}
Issues
Report issues and enhancements in the Github issue tracker.
Contributing
We encourage community contributions for this project! For more information on how to contribute to this project, see the contribution guidelines
LICENSE
Licensed under MIT, see LICENSE