set "VERSION_WITH_BRANCH" versionCreator as default #772
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aleksandrserbin
approved these changes
Jul 5, 2024
docs/configuration/version.md
Outdated
Comment on lines
268
to
272
| During this phase version will be decorated with branch name. | ||
| `axion-release-plugin` supports adding predefined named version creators | ||
| (so don't be afraid to post pull request if you have something useful!). | ||
| Decoration phase is conducted by *version creators*, | ||
| you can configure it via `scmVersion.versionCreator` |
There was a problem hiding this comment.
I would state more explicitly that default version creator is versionWithBranch
radoslaw-panuszewski
approved these changes
Jul 5, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There is a common problem with collaboration on code using this plugin.
When multiple feature branches are being developed (diverged from the same HEAD), by default, they will use a SIMPLE version creator that does not decorate versions in any way. So, both feature branches will generate the same version (v0.0.1-SNAPSHOT), leading to overriding snapshots during publication. That is prone to errors since Maven allows overriding SNAPSHOT versions.
This PR changes the default versionCreator to VERSION_WITH_BRANCH, which will append the branch name to version (v0.0.1-my-branch-name-SNAPSHOT) and will fallback to SIMPLE for detached HEAD checkouts (old behavior)
People who explicitly need the SIMPLE version will need to update their configurations.
Draft release