Upgrade Notes

This document specifies upgrade notes / changes to configuration options which become available in new releases.

1.6.0 - SCM All The Things

Rather than relying only upon environment variables injected by CI servers, we now leverage the SCM definition of the project wherever possible. This has had the following consequences:

• Branch patterns now include optional subgroup matching for the (origin/)? prefix.
• enforce-versions now expects the last subgroup from a match to equal the project version.
• The plugin can operate without environment variables being set, and will detect the current branch of the locally checked out git repo. In local environments, this even works as expected.
• To avoid the use of ${env.GIT_BRANCH} the plugin / extension will now use a developerConnection, connection, or ${env.GIT_BRANCH} (or the expression you provide) in that order, to resolve git branch, and to handle tagging.
• Since the plugin uses the SCMManager from maven now, the git command branch detection boils down the equivalent of this command: git symbolic-ref HEAD | sed 's/refs\/heads\///' being executed in the project base directory. Hence the optional sub-group match for (origin/)? now being part of the default patterns.
• The default development branch pattern has been changed to (origin/)?develop. If you were using the highly opinionated and verbose origin/development name, then you should specify this inside your plugin configuration.

Upgrading from 1.5.x

• Double check your developmentBranchPattern. You may need to specify one now (if you're using 'development' rather than 'develop')
• If you had to provide a custom gitBranchExpression, consider using the <scm> block of your project to define a <developerConnection>.
• If you have issues with git tagging, check your <scm> block to make sure you have the Git SCM URLs correctly formatted.