Allows releasing a reasonable next version number in a Jenkins pipeline with just a few lines of code.

The approach completely agnostic of what the actual build does. It rather computes the next reasonable version number in advance and allows to feed it as parameter into the remaining process. (Inspired by Maven Release Plugin: Dead and Buried)

See cor-jenkins-lib for the easiest way to add this to Jenkins and a more convenient scripting interface

library 'cor-jenkins-lib'

node {
  def vc = cor.release(this).newCalculator()
   
  vc.tags(
    sh(script: "git ${vc.gitFindTagsCommand}", returnStdout: true)
  )
  
  vc.messages(
    sh(script: "git ${vc.gitLogCommand}", returnStdout: true)
  )
  
  def version = vc.nextVersion
  
  // the actual build, for example using maven
  sh("mvn versions:set -DnewVersion=${version} versions:commit")
  sh("mvn clean verify")
  
  sh("git ${vc.gitNextTagCommand}")
  sh("git ${vc.gitPushTagCommand}")
}

It is built to support the following process:

0. Determine the last successful release from git tags
1. Look at all commit messages since that tag to determine whether minimal (patch level), minor or major changes were made (based on keywords)
2. Determines the next suitable version number for the current build
3. Apply that version and execute whatever the build does
4. On Success, tag the current commit with that version (and push the tag)
   • or on failure, don't -- the next commit will compute the same version and try to release it

Incrementing the version is based on the rules of semantic versioning, as implemented by the Java SemVerhttps://github.com/zafarkhaja/jsemver) library.

... that every successful build of a project is a release and increments the version number of that project.

The VersionCalculator supports two strategies as to what type of release is being produced by a build:

• VersionCalculator.release() always produces a regular release version, like 1.2.3
• VersionCalculator.snapshot() always produces a snapshot release, like 1.2.3-SNAPSHOT.17, which may be suitable if you don't really want to continuously release ;)

Both strategies can be combined, i.e. the release strategy will correctly bump to the next release if the previous version was a snapshot, and snapshot will bump to the next suitable snapshot version if the previous version was a full release. Both will properly increment major, minor or patch numbers.

You can define a prefix for the version tags.

VersionCalculator.release("v")

This will make the tool assume that version tags start with v:

v1.2.3
v1.2.4-SNAPSHOT.1

And of course also generate tags with that prefix. All tags not matching the prefix will be ignored.

Minor and major version number will only be incremented when certain keywords are found somewhere in the commit messages.

By default, the text CHANGE:MINOR triggers a minor version bump, and CHANGE:MAJOR triggers a major version bump.

You can change these by specifying lists of regular expressions:

vc.triggerMinorChange = [/minor API change/, /added functios/]
vc.triggerMajorChange = [/breaking API change/, /incompatible/]

By default, only the output of git log --pretty=oneline is used for keyword search. You can, however, perform any other command to obtain the text to search for keywords.

Use vc.gitLogVersionRange to get the correct range expression.

The VersionCalculator.snapshot() strategy is intended to create unique release numbers, too, according to the rules of semantic versioning. If it created an unnumbered snapshot version, the tag would not be unique and the whole process wouldn't work.

If you intend to do "classic" volatile -SNAPSHOT releases, the approach would rather be to use the VersionCalculator.release() strategy, append the suffix -SNAPSHOT yourself and not tag the commit (or move the tag and force push). You can still install/deploy the artifacts to any repository independent of tagging.

The next build would then compute the version again from the last full release. That would either compute the same next version (and thus the same SNAPSHOT) or a higher version one due to change keywords.