What's Changed
This release addresses a common issue with code collaboration using this plugin, particularly when multiple feature branches are being developed simultaneously from the same HEAD.
Problem
Until now, the plugin used a SIMPLE version creator by default, which did not decorate version in any way.
This default setting led to the following issues:
- Both feature branches would generate the same version (e.g.,
v0.0.1-SNAPSHOT). - During publication, this resulted in overridden snapshots, as Maven allows overwriting SNAPSHOT versions.
Solution
This release changes the default versionCreator to VERSION_WITH_BRANCH.
The new behavior includes:
- Appending the branch name to the version (e.g.,
v0.0.1-my-branch-name-SNAPSHOT). - Falling back to the SIMPLE version creator for detached HEAD checkouts, maintaining the old behavior in such cases.
Breaking change
- Versions will now include the branch name, preventing the override of snapshots across different branches.
Migration Guide
To continue using the SIMPLE version creator, update your plugin configuration as follows:
scmVersion {
versionCreator('simple')
}
Additional changes
- improve ci_servers.md GitLab CI branch override by @doofy in #760
- Use forUseAtConfigurationTime only for lower Gradle versions by @kkocel in #765
Dependencies
- Bump mkdocs-material from 9.5.20 to 9.5.25 by @dependabot in #763
- Bump org.objenesis:objenesis from 3.3 to 3.4 by @dependabot in #753
- Bump pl.allegro.tech.build.axion-release from 1.17.1 to 1.17.2 by @dependabot in #752
- Bump org.apache.sshd:sshd-git from 2.12.1 to 2.13.1 by @dependabot in #771
- Bump mkdocs-material from 9.5.25 to 9.5.27 by @dependabot in #769
- Bump org.apache.sshd:sshd-core from 2.12.1 to 2.13.1 by @dependabot in #770
- Bump com.github.mwiede:jsch from 0.2.17 to 0.2.18 by @dependabot in #766
- Bump jgitVersion from 6.9.0.202403050737-r to 6.10.0.202406032230-r by @dependabot in #768
New Contributors
Full Changelog: v1.17.2...v1.18.0