Document deprecations in PrepareReleaseMojo and PerformReleaseMojo#1448
Conversation
| * 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 |
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} |
There was a problem hiding this comment.
just "Use the {@code release:prepare-with-pom} goal instead."
There was a problem hiding this comment.
Thanks for the review. I’ve updated the Javadoc as requested.
anukalp2804
force-pushed
the
doc-deprecations-release-plugin
branch
from
56e7efd to
28abf56
Compare
| * <a href="/ref/3.8.5/maven-model-builder/super-pom.html">the super pom</a>. | ||
| * | ||
| * @deprecated The <code>release-profile</code> profile will be removed from future versions of the super POM | ||
| * Whether to use the default {@code release-profile} from the Maven super POM, which adds sources and javadocs to the released artifacts when appropriate. |
There was a problem hiding this comment.
This removes some content but does not document how to replace this method.
There was a problem hiding this comment.
Thanks for the review. I’ve updated the Javadoc to document the replacement approach as suggested.
anukalp2804
force-pushed
the
doc-deprecations-release-plugin
branch
from
28abf56 to
e2ad2d9
Compare
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
e2ad2d9 to
a546ec7
Compare
Thanks for the review. I’ve rebased onto upstream/master and resolved the conflicts. |
|
Hi, just checking in — this PR was approved earlier. Please let me know if anything else is needed from my side before it can be merged. Thanks! |
|
Thank you for the review and merge 🙂 |
2 participants
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.