Skip to content

Commit 56e7efd

Browse files
committed
Document deprecations in PrepareReleaseMojo and PerformReleaseMojo
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.
1 parent c828b26 commit 56e7efd

File tree

2 files changed

+23
-7
lines changed

2 files changed

+23
-7
lines changed

maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,22 @@ public class PerformReleaseMojo extends AbstractScmReadReleaseMojo {
8686
private boolean localCheckout;
8787

8888
/**
89-
* Whether to use the default release profile (Maven 2 and 3) that adds sources and javadocs to the released
90-
* artifact, if appropriate. If set to true, the release plugin sets the property "<code>performRelease</code>" to
91-
* true, which activates the profile "<code>release-profile</code>" as inherited from
92-
* <a href="/ref/3.8.5/maven-model-builder/super-pom.html">the super pom</a>.
89+
* Whether to use the default {@code release-profile} from the Maven
90+
* super POM (Maven 2 and 3), which adds sources and javadocs to the
91+
* released artifacts when appropriate.
9392
*
94-
* @deprecated The <code>release-profile</code> profile will be removed from future versions of the super POM
93+
* @deprecated The {@code release-profile} will be removed from future
94+
* versions of the Maven super POM and should no longer be
95+
* relied upon. Projects that require specific release
96+
* behavior should configure their own explicit build or
97+
* release profiles instead of depending on this implicit
98+
* profile.
99+
*
100+
* This parameter will be removed in a future version of the
101+
* plugin.
95102
*/
96-
@Parameter(defaultValue = "false", property = "useReleaseProfile")
97103
@Deprecated
104+
@Parameter(defaultValue = "false", property = "useReleaseProfile")
98105
private boolean useReleaseProfile;
99106

100107
/**

maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,16 @@ public class PrepareReleaseMojo extends AbstractScmReadWriteReleaseMojo {
6262
private boolean resume;
6363

6464
/**
65-
* @deprecated Please use release:prepare-with-pom instead.
65+
* Controls whether the plugin should generate release POMs during the
66+
* prepare phase.
67+
*
68+
* @deprecated This flag is no longer the preferred way to perform a
69+
* release. Use the dedicated {@code release:prepare-with-pom}
70+
* goal instead, which provides a clearer and more explicit
71+
* workflow for preparing releases that require generated POMs.
72+
*
73+
* This parameter will be removed in a future version of the
74+
* plugin.
6675
*/
6776
@Deprecated
6877
@Parameter(defaultValue = "false", property = "generateReleasePoms")

0 commit comments

Comments
 (0)