Skip to content

Commit a546ec7

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 66b26b5 commit a546ec7

File tree

2 files changed

+13
-7
lines changed

2 files changed

+13
-7
lines changed

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

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,14 +86,17 @@ 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>.
93-
* @deprecated The <code>release-profile</code> profile will be removed from future versions of the super POM
89+
* Whether to use the default {@code release-profile} from the Maven super POM,
90+
* which adds sources and javadocs to the released artifacts when appropriate.
91+
*
92+
* @deprecated The {@code release-profile} is being removed from future versions
93+
* of the Maven super POM. Projects that require sources or javadocs
94+
* to be attached during a release should configure their own
95+
* explicit build or release profiles instead of relying on this
96+
* implicit profile.
9497
*/
95-
@Parameter(defaultValue = "false", property = "useReleaseProfile")
9698
@Deprecated
99+
@Parameter(defaultValue = "false", property = "useReleaseProfile")
97100
private boolean useReleaseProfile;
98101

99102
/**

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,10 @@ 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 Use the {@code release:prepare-with-pom} goal instead.
6669
*/
6770
@Deprecated
6871
@Parameter(defaultValue = "false", property = "generateReleasePoms")

0 commit comments

Comments
 (0)