Document deprecations in PrepareReleaseMojo and PerformReleaseMojo #1448
+16
−11
Conversation
This file contains hidden or 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
Clarified that getModel() is a temporary legacy accessor and will be removed once transform() is fully implemented. Added guidance to rely on the extract -> transform -> load pipeline instead.
elharo
requested changes
Jan 8, 2026
| * true, which activates the profile "<code>release-profile</code>" as inherited from | ||
| * <a href="/ref/3.8.5/maven-model-builder/super-pom.html">the super pom</a>. | ||
| * Whether to use the default {@code release-profile} from the Maven | ||
| * super POM (Maven 2 and 3), which adds sources and javadocs to the |
| * Controls whether the plugin should generate release POMs during the | ||
| * prepare phase. | ||
| * | ||
| * @deprecated This flag is no longer the preferred way to perform a |
Contributor
There was a problem hiding this comment.
delete "This flag is no longer the preferred way to perform a release."
| * prepare phase. | ||
| * | ||
| * @deprecated This flag is no longer the preferred way to perform a | ||
| * release. Use the dedicated {@code release:prepare-with-pom} |
Contributor
There was a problem hiding this comment.
just "Use the {@code release:prepare-with-pom} goal instead."
Contributor
Author
There was a problem hiding this comment.
Thanks for the review. I’ve updated the Javadoc as requested.
Improved documentation for deprecated parameters: - generateReleasePoms: explained deprecation and pointed users to release:prepare-with-pom. - useReleaseProfile: clarified that the super POM release-profile is being removed and projects should rely on explicit profiles instead. No functional changes. Build verified.
anukalp2804
force-pushed
the
doc-deprecations-release-plugin
branch
from
56e7efd to
28abf56
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR is part of Issue #1436 – Document Deprecations and improves the
documentation of deprecated parameters in the Maven Release Plugin.
to explain why it is deprecated and recommend using
release:prepare-with-pom instead.
to clarify that the Maven super POM release-profile is being removed
and projects should rely on explicit project-defined release profiles.
mvn clean install.Reference: #1436
/cc @elharo
Following this checklist to help us incorporate your
contribution quickly and easily:
Note that commits might be squashed by a maintainer on merge.
This may not always be possible but is a best-practice.
mvn verifyto make sure basic checks pass.A more thorough check will be performed on your pull request automatically.
mvn -Prun-its verify).If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.
To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.