You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by hb...@apache.org on 2022/05/06 04:47:42 UTC
[maven-release] branch MRELEASE-955 updated: [MRELEASE-955] rephrase the page to "upgrade from 2 to 3"
This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch MRELEASE-955
in repository https://gitbox.apache.org/repos/asf/maven-release.git
The following commit(s) were added to refs/heads/MRELEASE-955 by this push:
new b406a68b [MRELEASE-955] rephrase the page to "upgrade from 2 to 3"
b406a68b is described below
commit b406a68bfe06f73f68bee537d3a7dd3187990a1a
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Fri May 6 06:47:39 2022 +0200
[MRELEASE-955] rephrase the page to "upgrade from 2 to 3"
---
.../{examples/release-profiles.apt => upgrade.apt} | 28 +++++++++++++++++-----
maven-release-plugin/src/site/site.xml | 1 +
2 files changed, 23 insertions(+), 6 deletions(-)
diff --git a/maven-release-plugin/src/site/apt/examples/release-profiles.apt b/maven-release-plugin/src/site/apt/upgrade.apt
similarity index 62%
rename from maven-release-plugin/src/site/apt/examples/release-profiles.apt
rename to maven-release-plugin/src/site/apt/upgrade.apt
index 3d9bb951..adbfe070 100644
--- a/maven-release-plugin/src/site/apt/examples/release-profiles.apt
+++ b/maven-release-plugin/src/site/apt/upgrade.apt
@@ -1,5 +1,5 @@
------
- Release Profiles
+ Upgrading Maven Release Plugin From 2 to 3
------
------
2022-04-24
@@ -25,9 +25,11 @@
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
-Release Profiles
+Upgrading Maven Release Plugin From 2 to 3
- Maven 3 provides a default release profile named <<<release-profile>>> that builds and attaches source and javadoc jar:
+* Context: Maven 3 and Maven 4
+
+ Maven 3 (and previously 2) provides a default release profile named <<<release-profile>>> that builds and attaches source and javadoc jar:
this is defined in {{{/ref/3.8.5/maven-model-builder/super-pom.html}the super POM}}. This profile is activated by default during <<<release:perform>>>
with Maven Release Plugin 2.x, unless deactivated by configuring <<<useReleaseProfile>>> parameter to <<<false>>>.
@@ -35,8 +37,22 @@ Release Profiles
To prepare for this removal, Maven Release Plugin 3.0 stopped invoking this profile by default: <<<useReleaseProfile>>> parameter is <<<false>>> by default.
- When upgrading Maven Release Plugin from 2 to 3, configuring explicitely <<<useReleaseProfile>>> parameter to <<<true>>> will provide a
- temporary solution, working only with Maven 3.
+* Upgrading Maven Release Plugin 2 to 3
+
+** Write And Configure Your Own Release Profile
In order to prepare for Maven 4, each project will instead require to define their own release profile that they'll be able to customise
- to match their needs.
+ to match their needs:
+
+ * for internal projects, just configure the <<<maven-source-plugin>>> for example
+
+ * for projects published to Maven Central repository, you'll need to add also <<<maven-javadoc-plugin>>> and <<<maven-gpg-plugin>>>: see
+ {{{https://central.sonatype.org/publish/publish-maven/}the documentation}}
+
+ []
+
+** Short Term: Force Using Maven 3-only Default Release Profile
+
+ Configuring explicitely <<<useReleaseProfile>>> parameter to <<<true>>> will force Maven Release Plugin 3 to work like version 2.
+
+ It provides an easy but temporary solution, working only with Maven 3, when you can't yet write your own release profile.
diff --git a/maven-release-plugin/src/site/site.xml b/maven-release-plugin/src/site/site.xml
index a6907be5..67d10dc3 100644
--- a/maven-release-plugin/src/site/site.xml
+++ b/maven-release-plugin/src/site/site.xml
@@ -34,6 +34,7 @@ under the License.
<item name="Introduction" href="index.html"/>
<item name="Goals" href="plugin-info.html"/>
<item name="Usage" href="usage.html"/>
+ <item name="Upgrade" href="upgrade.html"/>
<item name="FAQ" href="faq.html"/>
<!-- According to https://issues.apache.org/jira/browse/MNGSITE-152 -->
<item name="License" href="http://www.apache.org/licenses/"/>