This is an automated email from the ASF dual-hosted git repository.
elharo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-release.git
The following commit(s) were added to refs/heads/master by this push:
new 9ca1a851 Document deprecations in PrepareReleaseMojo and
PerformReleaseMojo (#1448)
9ca1a851 is described below
commit 9ca1a851460caa7d61d1609e7e877a99800c088e
Author: Anukalp Pandey <[email protected]>
AuthorDate: Mon Feb 16 01:47:14 2026 +0530
Document deprecations in PrepareReleaseMojo and PerformReleaseMojo (#1448)
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.
---
.../apache/maven/plugins/release/PerformReleaseMojo.java | 15 +++++++++------
.../apache/maven/plugins/release/PrepareReleaseMojo.java | 5 ++++-
2 files changed, 13 insertions(+), 7 deletions(-)
diff --git
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
index 0efe1435..0e5fbaf6 100644
---
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
+++
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PerformReleaseMojo.java
@@ -86,14 +86,17 @@ public class PerformReleaseMojo extends
AbstractScmReadReleaseMojo {
private boolean localCheckout;
/**
- * Whether to use the default release profile (Maven 2 and 3) that adds
sources and javadocs to the released
- * artifact, if appropriate. If set to true, the release plugin sets the
property "<code>performRelease</code>" to
- * 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>.
- * @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.
+ *
+ * @deprecated The {@code release-profile} is being removed from future
versions
+ * of the Maven super POM. Projects that require sources or
javadocs
+ * to be attached during a release should configure their own
+ * explicit build or release profiles instead of relying on
this
+ * implicit profile.
*/
- @Parameter(defaultValue = "false", property = "useReleaseProfile")
@Deprecated
+ @Parameter(defaultValue = "false", property = "useReleaseProfile")
private boolean useReleaseProfile;
/**
diff --git
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
index 4993d69d..3932b0ba 100644
---
a/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
+++
b/maven-release-plugin/src/main/java/org/apache/maven/plugins/release/PrepareReleaseMojo.java
@@ -62,7 +62,10 @@ public class PrepareReleaseMojo extends
AbstractScmReadWriteReleaseMojo {
private boolean resume;
/**
- * @deprecated Please use release:prepare-with-pom instead.
+ * Controls whether the plugin should generate release POMs during the
+ * prepare phase.
+ *
+ * @deprecated Use the {@code release:prepare-with-pom} goal instead.
*/
@Deprecated
@Parameter(defaultValue = "false", property = "generateReleasePoms")