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/23 06:39:05 UTC
[maven-release] branch master updated: update documentation: consistency, describe Git example instead of svn
This is an automated email from the ASF dual-hosted git repository.
hboutemy 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 07965ca0 update documentation: consistency, describe Git example instead of svn
07965ca0 is described below
commit 07965ca0679d99301f5286d8de1a4b5b13e7b057
Author: Hervé Boutemy <hb...@apache.org>
AuthorDate: Mon May 23 08:39:02 2022 +0200
update documentation: consistency, describe Git example instead of svn
---
.../site/apt/examples/generate-release-poms.apt | 8 +-
.../site/apt/examples/non-interactive-release.apt | 4 +-
.../src/site/apt/examples/perform-release.apt.vm | 8 +-
.../src/site/apt/examples/prepare-release.apt.vm | 10 +--
.../apt/examples/run-goals-before-commit.apt.vm | 2 +-
maven-release-plugin/src/site/apt/index.apt | 4 +-
maven-release-plugin/src/site/apt/usage.apt.vm | 88 +++++++++++-----------
7 files changed, 63 insertions(+), 61 deletions(-)
diff --git a/maven-release-plugin/src/site/apt/examples/generate-release-poms.apt b/maven-release-plugin/src/site/apt/examples/generate-release-poms.apt
index c722143b..3bd05f35 100644
--- a/maven-release-plugin/src/site/apt/examples/generate-release-poms.apt
+++ b/maven-release-plugin/src/site/apt/examples/generate-release-poms.apt
@@ -30,16 +30,16 @@ Generate Release POMs
To generate POMs with resolved information (e.g. version numbers) to check the values that the Release Plugin will use,
execute the <<<prepare-with-pom>>> goal. Resolved values will be saved in <<<release-pom.xml>>>.
-+-------
+-------
mvn release:prepare-with-pom
-+-------
+-------
This relies on <<<release.properties>>> being present from a previous release preparation. If this is not the case,
you need to give the goal the name of the URL and optional tag to perform the release from. For example:
-+-------
+-------
mvn release:prepare-with-pom
-DconnectionUrl=scm:svn:https://svn.apache.org/repos/asf/maven/plugins/tags/maven-release-plugin-2.0
-+-------
+-------
After the release is complete, the <<<release.properties>>> and other release files will be removed from the checkout.
diff --git a/maven-release-plugin/src/site/apt/examples/non-interactive-release.apt b/maven-release-plugin/src/site/apt/examples/non-interactive-release.apt
index 70fd1630..fbb634df 100644
--- a/maven-release-plugin/src/site/apt/examples/non-interactive-release.apt
+++ b/maven-release-plugin/src/site/apt/examples/non-interactive-release.apt
@@ -88,11 +88,11 @@ mvn --batch-mode -Dtag=my-proj-1.2 -Dproject.rel.org.myCompany:projectA=1.2 \
and the release and SNAPSHOT versions follow the same conventions as they do on the
command line.
------------
++-----------
scm.tag=my-proj-1.2
project.rel.org.myCompany\:projectA=1.2
project.dev.org.myCompany\:projectA=1.3-SNAPSHOT
------------
++-----------
<<Note:>> Remember to escape the colon with a backslash, otherwise the property will not be
interpreted correctly.
diff --git a/maven-release-plugin/src/site/apt/examples/perform-release.apt.vm b/maven-release-plugin/src/site/apt/examples/perform-release.apt.vm
index bb772cca..002c9fa3 100644
--- a/maven-release-plugin/src/site/apt/examples/perform-release.apt.vm
+++ b/maven-release-plugin/src/site/apt/examples/perform-release.apt.vm
@@ -31,7 +31,7 @@ Perform a Release
* Checkout from an SCM URL with optional tag
- * Run the predefined Maven goals to release the project (by default, <<<deploy site-deploy>>>)
+ * Run the perform Maven goals to release the project (by default, <<<deploy site-deploy>>>), eventually with release profile(s) active
[]
@@ -58,7 +58,7 @@ mvn org.apache.maven.plugins:maven-release-plugin:${project.version}:perform -Dc
at release-time) by setting a comma separated list of profiles names in the <<<releaseProfiles>>> parameter. The goals and
profiles required to release the project can then be configured in the POM:
--------
++-------
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-release-plugin</artifactId>
@@ -70,6 +70,8 @@ mvn org.apache.maven.plugins:maven-release-plugin:${project.version}:perform -Dc
<releaseProfiles>release</releaseProfiles>
</configuration>
</plugin>
--------
++-------
+
+ Maven Release Plugin 2.x also activated a default profile by default, but not Maven Release Plugin 3.x: see {{{../migrate.html}migrate documentation}} for more details.
After the release is complete, the <<<release.properties>>> and other release files will be removed from the checkout.
diff --git a/maven-release-plugin/src/site/apt/examples/prepare-release.apt.vm b/maven-release-plugin/src/site/apt/examples/prepare-release.apt.vm
index a9ae5ef2..d7cf6a4a 100644
--- a/maven-release-plugin/src/site/apt/examples/prepare-release.apt.vm
+++ b/maven-release-plugin/src/site/apt/examples/prepare-release.apt.vm
@@ -38,7 +38,7 @@ Prepare a Release
* Transform the SCM information in the POM to include the final destination of the tag
- * Run the project tests against the modified POMs to confirm everything is in working order
+ * Run the project tests (preparation goals) against the modified POMs to confirm everything is in working order
* Commit the modified POMs
@@ -97,10 +97,10 @@ mvn release:prepare-with-pom
* Overriding the default tag name format
- By default, if you do not specify a tag name, a default tag name of <<<artifactId>>>-<<<version>>> will be
- suggested (and if running non-interactively used).
+ By default, if you do not specify a tag name, a default tag name of <<<artifactId-version>>> will be
+ suggested (and used if running non-interactively).
- You can specify the exact tag name to use from the command line by passing the <<<tag>>> property, but if you
+ You can override proposed value with the exact tag name to use from the command line by passing the <<<tag>>> property (<<<-Dtag=my-tag>>>). If you
want to have the tag name generated, but just change the default pattern, you can use the <<<tagNameFormat>>>
configuration option.
@@ -143,4 +143,4 @@ mvn release:prepare-with-pom
[]
- The <<<project.>>> prefix is optional and may be omitted.
\ No newline at end of file
+ The <<<project.>>> prefix is optional and may be omitted.
diff --git a/maven-release-plugin/src/site/apt/examples/run-goals-before-commit.apt.vm b/maven-release-plugin/src/site/apt/examples/run-goals-before-commit.apt.vm
index 00563ff3..1e77265e 100644
--- a/maven-release-plugin/src/site/apt/examples/run-goals-before-commit.apt.vm
+++ b/maven-release-plugin/src/site/apt/examples/run-goals-before-commit.apt.vm
@@ -27,7 +27,7 @@
Run Additional Goals Before Commit
- To run additional goals after release preparation but before committing, specify them using the <<<preparationGoals>>>
+ To run additional goals after release preparation (tag) but before committing with new -SNAPSHOT version, specify them using the <<<preparationGoals>>>
property.
+-----
diff --git a/maven-release-plugin/src/site/apt/index.apt b/maven-release-plugin/src/site/apt/index.apt
index 832be4f4..25d2de3d 100644
--- a/maven-release-plugin/src/site/apt/index.apt
+++ b/maven-release-plugin/src/site/apt/index.apt
@@ -30,7 +30,7 @@ Maven Release Plugin
This plugin is used to release a project with Maven, saving a lot of repetitive, manual work.
Releasing a project is made in two steps: prepare and perform.
- <<Note: Maven 3 users are encouraged to use at least {{{http://maven.apache.org/download.html}Maven-3.0.4}} due to some settings related issues.>>
+ <<Note: Maven 3 users are encouraged to use at least {{{/download.html}Maven-3.0.4}} due to some settings related issues.>>
* Goals Overview
@@ -67,7 +67,7 @@ Maven Release Plugin
entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out the project from our
{{{./scm.html}source repository}} and will find supplementary information in the
- {{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
+ {{{/guides/development/guide-helping.html}guide to helping with Maven}}.
* Examples
diff --git a/maven-release-plugin/src/site/apt/usage.apt.vm b/maven-release-plugin/src/site/apt/usage.apt.vm
index 2436aab1..1e609d44 100644
--- a/maven-release-plugin/src/site/apt/usage.apt.vm
+++ b/maven-release-plugin/src/site/apt/usage.apt.vm
@@ -30,7 +30,7 @@ Usage
* Prepare your project to use the maven-release-plugin
- To be able to make a solid start with the maven-release-plugin, there are 2 things you should include in our pom:
+ To be able to make a solid start with the maven-release-plugin, there are 2 things you should include in your pom:
* the <<<scm>>>-section with a <<<developerConnection>>>
@@ -40,14 +40,14 @@ Usage
The <<<developerConnection>>> contains the URL of the Source Control Management system pointing to the folder containing this <<<pom.xml>>>
This URL is prefixed with <<<scm:[scm-provider]>>> so the plugin can pick the right implementation for committing and tagging.
- The {{{http://maven.apache.org/scm/scms-overview.html}Maven SCM}}-page contains an overview all the supported SCMs, per SCM you can see how the URL should look like.
+ The {{{/scm/scms-overview.html}Maven SCM}}-page contains an overview all the supported SCMs, per SCM you can see how the URL should look like:
+--------
<project>
...
<scm>
- <developerConnection>scm:svn:https://svn.mycompany.com/repos/myapplication/trunk/mycomponent/</developerConnection>
+ <developerConnection>scm:git:https://github.com/my-org/my-project.git</developerConnection>
</scm>
<build>
@@ -69,59 +69,24 @@ Usage
The following are some common scenarios in preparing a release.
-* Use a different username in the SCM server than the one in the operating system
-
- Most of the SCMs are simply executed as an external command as the current user on your system. If this username is
- not the same as the SCM username, you may need to set the following option:
-
-+------
-mvn -Dusername=your_scm_username release:prepare
-+------
-
-* Set where to tag the files in Subversion
-
- This example shows how to set the repository location for all tags to be created in Subversion.
- Note that this is not needed if you use the standard SVN layout, where the root project is in <<<trunk>>>, and
- there is a sibling <<<tags>>> directory.
-
-+-------------------
-<project>
- ...
- <build>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-release-plugin</artifactId>
- <version>${project.version}</version>
- <configuration>
- <tagBase>https://svn.mycompany.com/repos/myapplication/releases</tagBase>
- </configuration>
- </plugin>
- </plugins>
- ...
- </build>
- ...
-</project>
-+-------------------
-
* Do a Dry Run
Since the Release Plugin performs a number of operations that change the project, it may be wise to do a dry run
before a big release or on a new project. To do this, commit all of your files as if you were about to run a full
release and run:
-+------
+------
mvn release:prepare -DdryRun
-+------
+------
This will ask all the same questions, run the same tests, and output a copy of how the POMs will look after
transformation. You can check the output and review the POMs, then run:
-+------
-mvn release:clean
-+------
+------
+mvn release:perform -DdryRun
+------
- This will remove all of the files created above, and the project will be ready to execute the proper release.
+ This will show the perform actions then clean the project, ie. remove all of the files created above, and the project will be ready to execute the proper release.
* Run in Batch Mode
@@ -151,3 +116,38 @@ mvn --batch-mode release:prepare
you can still execute a <<<release:rollback>>> if some error has been detected and a new candidate must
be created after some fixes. You just need to use a distinct tag in SCM, or rename the one that has been created
if the SCM provider supports renaming tags.
+
+* Use a different username in the SCM server than the one in the operating system
+
+ Most of the SCMs are simply executed as an external command as the current user on your system. If this username is
+ not the same as the SCM username, you may need to set the following option:
+
+------
+mvn -Dusername=your_scm_username release:prepare
+------
+
+* Set where to tag the files in Subversion
+
+ This example shows how to set the repository location for all tags to be created in Subversion.
+ Note that this is not needed if you use the standard SVN layout, where the root project is in <<<trunk>>>, and
+ there is a sibling <<<tags>>> directory.
+
++-------------------
+<project>
+ ...
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-release-plugin</artifactId>
+ <version>${project.version}</version>
+ <configuration>
+ <tagBase>https://svn.mycompany.com/repos/myapplication/releases</tagBase>
+ </configuration>
+ </plugin>
+ </plugins>
+ ...
+ </build>
+ ...
+</project>
++-------------------