You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@maven.apache.org by de...@apache.org on 2010/01/03 02:47:31 UTC
svn commit: r895315 - in /maven/release/trunk/maven-release-plugin/src/site:
./ apt/ apt/examples/
Author: dennisl
Date: Sun Jan 3 01:47:31 2010
New Revision: 895315
URL: http://svn.apache.org/viewvc?rev=895315&view=rev
Log:
o Improve the plugin site. This includes linking to the existing 'Rollback a Release' page, that was requested on the dev list.
Modified:
maven/release/trunk/maven-release-plugin/src/site/apt/examples/branch.apt
maven/release/trunk/maven-release-plugin/src/site/apt/examples/generate-release-poms.apt
maven/release/trunk/maven-release-plugin/src/site/apt/examples/lock-files.apt
maven/release/trunk/maven-release-plugin/src/site/apt/examples/non-interactive-release.apt
maven/release/trunk/maven-release-plugin/src/site/apt/examples/perform-release.apt.vm
maven/release/trunk/maven-release-plugin/src/site/apt/examples/prepare-release.apt
maven/release/trunk/maven-release-plugin/src/site/apt/examples/rollback-release.apt
maven/release/trunk/maven-release-plugin/src/site/apt/examples/run-goals-before-commit.apt.vm
maven/release/trunk/maven-release-plugin/src/site/apt/examples/update-versions.apt
maven/release/trunk/maven-release-plugin/src/site/apt/index.apt
maven/release/trunk/maven-release-plugin/src/site/apt/usage.apt.vm
maven/release/trunk/maven-release-plugin/src/site/site.xml
Modified: maven/release/trunk/maven-release-plugin/src/site/apt/examples/branch.apt
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/site/apt/examples/branch.apt?rev=895315&r1=895314&r2=895315&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/apt/examples/branch.apt (original)
+++ maven/release/trunk/maven-release-plugin/src/site/apt/examples/branch.apt Sun Jan 3 01:47:31 2010
@@ -1,9 +1,10 @@
------
- Create a branch
+ Create a Branch
------
Emmanuel Venisse <ev...@apache.org>
------
- May 16, 2007
+ 2010-01-03
+ ------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -22,13 +23,13 @@
~~ specific language governing permissions and limitations
~~ under the License.
-Create a branch
+Create a Branch
- Creating a branch executes the following steps:
+ Creating a branch involves the following steps:
* Check that there are no uncommitted changes in the sources
- * Change the version in the poms if you want to change it in the branch (you will be prompted for the versions to use)
+ * Change the version in the POMs if you want to change it in the branch (you will be prompted for the versions to use)
* Transform the SCM information in the POM to include the final destination of the tag
@@ -40,34 +41,33 @@
* Commit the modified POMs
- To execute this step, run:
+ To create a branch execute this command:
-------
mvn release:branch -DbranchName=my-branch
-------
- By default, the pom in the new branch keeps the same version as the local working copy, and the local pom is incremented
+ By default, the POM in the new branch keeps the same version as the local working copy, and the local POM is incremented
to the next revision. If you want to update versions in the new branch and not in the working copy, run:
-------
mvn release:branch -DbranchName=my-branch -DupdateBranchVersions=true -DupdateWorkingCopyVersions=false
-------
- <<Note:>> It can be useful if you want to create a branch from a tag
-
-
-* Specify versions on the command line.
+ <<Note:>> This can be useful if you want to create a branch from a tag
+
+
+* Specify versions on the command line
You may want to specify the versions to use on the command line. This can be useful for example if you are running
- the release in non-interactive mode. The branch goal can use the same properties used by the prepare goal for
+ the release in non-interactive mode. The <<<branch>>> goal can use the same properties used by the <<<prepare>>> goal for
specifying the versions to be used.
-
+
-----------
mvn --batch-mode release:branch -DbranchName=my-branch-1.2 -Dproject.rel.org.myCompany:projectA=1.2 \
-Dproject.dev.org.myCompany:projectA=2.0-SNAPSHOT
-----------
- In this example, the pom in the new branch will be set to the version 1.2-SNAPSHOT, and the pom in the
- local pom will be set to the version 2.0-SNAPSHOT
-
\ No newline at end of file
+ In this example, the POM in the new branch will be set to the version 1.2-SNAPSHOT, and the
+ local POM will be set to the version 2.0-SNAPSHOT.
Modified: maven/release/trunk/maven-release-plugin/src/site/apt/examples/generate-release-poms.apt
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/site/apt/examples/generate-release-poms.apt?rev=895315&r1=895314&r2=895315&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/apt/examples/generate-release-poms.apt (original)
+++ maven/release/trunk/maven-release-plugin/src/site/apt/examples/generate-release-poms.apt Sun Jan 3 01:47:31 2010
@@ -5,7 +5,8 @@
Brett Porter <br...@apache.org>
John Tolentino <jt...@apache.org>
------
- September 18, 2006
+ 2010-01-03
+ ------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -26,7 +27,7 @@
Generate Release POMs
- To generate poms with resolved information (e.g. version numbers) to check the values that the release plugin will use,
+ To generate POMs with resolved information (e.g. version numbers) to check the values that the Release Plugin will use,
set the property <<<generateReleasePoms>>> to <<<true>>>. Resolved values will be saved in <<<release-pom.xml>>>.
-------
@@ -41,4 +42,4 @@
-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.
\ No newline at end of file
+ After the release is complete, the <<<release.properties>>> and other release files will be removed from the checkout.
Modified: maven/release/trunk/maven-release-plugin/src/site/apt/examples/lock-files.apt
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/site/apt/examples/lock-files.apt?rev=895315&r1=895314&r2=895315&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/apt/examples/lock-files.apt (original)
+++ maven/release/trunk/maven-release-plugin/src/site/apt/examples/lock-files.apt Sun Jan 3 01:47:31 2010
@@ -5,7 +5,8 @@
Brett Porter <br...@apache.org>
John Tolentino <jt...@apache.org>
------
- September 18, 2006
+ 2010-01-03
+ ------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -29,7 +30,7 @@
Lock Files During Release
- If you want to lock the files during release operation set the property <<<useEditMode>>> to <<<true>>>. The default
+ If you want to lock the files during a release operation set the property <<<useEditMode>>> to <<<true>>>. The default
value of this property is <<<false>>>.
-------
@@ -44,4 +45,4 @@
-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.
\ No newline at end of file
+ After the release is complete, the <<<release.properties>>> and other release files will be removed from the checkout.
Modified: maven/release/trunk/maven-release-plugin/src/site/apt/examples/non-interactive-release.apt
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/site/apt/examples/non-interactive-release.apt?rev=895315&r1=895314&r2=895315&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/apt/examples/non-interactive-release.apt (original)
+++ maven/release/trunk/maven-release-plugin/src/site/apt/examples/non-interactive-release.apt Sun Jan 3 01:47:31 2010
@@ -1,9 +1,10 @@
------
- Performing a non-interactive release
+ Performing a Non-interactive Release
------
Paul Gier
------
- April 22, 2008
+ 2010-01-03
+ ------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -22,35 +23,35 @@
~~ specific language governing permissions and limitations
~~ under the License.
-Performing a non-interactive release
+Performing a Non-interactive Release
In some environments, it may be necessary to perform a non-interactive release. This means that
- the release plugin will obtain the required parameters from system properties (set on the command line)
+ the Release Plugin will obtain the required parameters from system properties (set on the command line)
or from a properties file (<<<release.properties>>>).
-
- To prevent the release plugin from promting the user for any information, maven should be put into
+
+ To prevent the Release Plugin from promting the user for any information, Maven should be put into
batch mode.
-
+
-----------
mvn -B release:prepare
------------
+-----------
or
-
+
-----------
mvn --batch-mode release:prepare
-----------
* Using system properties
- Using batch mode with no other configuration will cause the release plugin to use default values
- for the release version, the scm tag, and the next development version. These values can also
+ Using batch mode with no other configuration will cause the Release Plugin to use default values
+ for the release version, the SCM tag, and the next development version. These values can also
be set from the command line.
- The scm tag name can be set using the <<<tag>>> property. And default values for the release version
+ The SCM tag name can be set using the <<<tag>>> property. And default values for the release version
and new development version can be set using the properties <<<releaseVersion>>> and
<<<developmentVersion>>> respectively.
-
+
-----------
mvn --batch-mode -Dtag=my-proj-1.2 release:prepare \
-DreleaseVersion=1.2 \
@@ -59,39 +60,39 @@
* Multi-module releases
- Because there is the possibility that a release will include multiple release versions and
- snapshot versions (for a multi-module project), there is a specific format for setting these
- values. The property name should start with <<<project.rel>>> for release versions and
- <<<project.dev>>> for the new development version. These prefixes are followed by the
- maven groupId and artifactId (separated by a colon). So the result looks something like
+ Because there is the possibility that a release will include multiple release versions and
+ SNAPSHOT versions (for a multi-module project), there is a specific format for setting these
+ values. The property name should start with <<<project.rel>>> for release versions and
+ <<<project.dev>>> for the new development version. These prefixes are followed by the
+ project's groupId and artifactId (separated by a colon). So the result looks something like
the following example.
-
+
-----------
mvn --batch-mode -Dtag=my-proj-1.2 -Dproject.rel.org.myCompany:projectA=1.2 \
-Dproject.dev.org.myCompany:projectA=1.3-SNAPSHOT release:prepare
-----------
- Using this convention, multiple release versions and snapshot versions (one for each
+ Using this convention, multiple release versions and SNAPSHOT versions (one for each
project module) can be specified on the command line.
-
+
These properties can be used in combination with the <<<releaseVersion>>> and
<<<developmentVersion>>>. In the case where both are used, <<<releaseVersion>>> and
<<<developmentVersion>>> act as defaults for modules that have not been given specific
values using the <<<groupId:artifactId>>> format.
-
-
+
+
* Using a properties file
- Another option is to create a properties file that contains the version information for
+ Another option is to create a properties file that contains the version information for
the project you would like to release. The properties file should be called <<<release.properties>>>
- and the release and snapshot versions follow the same conventions as they do on the
+ 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.
Modified: maven/release/trunk/maven-release-plugin/src/site/apt/examples/perform-release.apt.vm
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/site/apt/examples/perform-release.apt.vm?rev=895315&r1=895314&r2=895315&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/apt/examples/perform-release.apt.vm (original)
+++ maven/release/trunk/maven-release-plugin/src/site/apt/examples/perform-release.apt.vm Sun Jan 3 01:47:31 2010
@@ -1,11 +1,12 @@
------
- Perform a release
+ Perform a Release
------
Carlos Sanchez <ca...@apache.org>
Brett Porter <br...@apache.org>
John Tolentino <jt...@apache.org>
------
- September 18, 2006
+ 2010-01-03
+ ------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -24,7 +25,7 @@
~~ specific language governing permissions and limitations
~~ under the License.
-Perform a release
+Perform a Release
Performing a release does the following:
@@ -32,7 +33,9 @@
* Run the predefined Maven goals to release the project (by default, <<<deploy site-deploy>>>)
- To execute this step, run:
+ []
+
+ To perform a release execute this command:
-------
mvn release:perform
@@ -45,14 +48,14 @@
mvn release:perform -DconnectionUrl=scm:svn:https://svn.apache.org/repos/asf/maven/plugins/tags/maven-release-plugin-2.0
-------
- release:perform will fork a new maven instance to build the checked-out project. This new maven instance will use the
- same system configuration and maven profiles used by the one running the release:perform goal.
-
+ <<<release:perform>>> will fork a new Maven instance to build the checked-out project. This new Maven instance will use the
+ same system configuration and Maven profiles used by the one running the <<<release:perform>>> goal.
+
It is possible to
force some profiles to get enabled during release (for example to enable time-consummung tasks that are only relevant
- at release-time) by setting a coma 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 :
-
+ 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>
<artifactId>maven-release-plugin</artifactId>
@@ -67,4 +70,4 @@
</plugin>
-------
- After the release is complete, the <<<release.properties>>> and other release files will be removed from the checkout.
\ No newline at end of file
+ After the release is complete, the <<<release.properties>>> and other release files will be removed from the checkout.
Modified: maven/release/trunk/maven-release-plugin/src/site/apt/examples/prepare-release.apt
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/site/apt/examples/prepare-release.apt?rev=895315&r1=895314&r2=895315&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/apt/examples/prepare-release.apt (original)
+++ maven/release/trunk/maven-release-plugin/src/site/apt/examples/prepare-release.apt Sun Jan 3 01:47:31 2010
@@ -1,11 +1,13 @@
------
- Prepare a release
+ Prepare a Release
------
Carlos Sanchez <ca...@apache.org>
Brett Porter <br...@apache.org>
John Tolentino <jt...@apache.org>
+ Dennis Lundberg <de...@apache.org>
+ ------
+ 2010-01-03
------
- September 18, 2006
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -24,15 +26,15 @@
~~ specific language governing permissions and limitations
~~ under the License.
-Prepare a release
+Prepare a Release
- Preparing a release executes the following steps:
+ Preparing a release goes through the following steps:
* Check that there are no uncommitted changes in the sources
* Check that there are no SNAPSHOT dependencies
- * Change the version in the poms from x-SNAPSHOT to a new version (you will be prompted for the versions to use)
+ * Change the version in the POMs from x-SNAPSHOT to a new version (you will be prompted for the versions to use)
* Transform the SCM information in the POM to include the final destination of the tag
@@ -46,7 +48,9 @@
* Commit the modified POMs
- To execute this step, run:
+ []
+
+ To prepare a release execute this command:
-------
mvn release:prepare
@@ -68,4 +72,11 @@
-------
<<Note:>> If any changes have been made to your source files they might need to be reverted before you restart the
- prepare process. You can use <<release:rollback>> to make the plugin do it for you.
+ prepare process. You can use <<<release:rollback>>> to make the plugin do it for you.
+
+* Multi-module projects
+
+ You will be prompted for the version number for each module of the project.
+ If you prefer that every module gets the same version as the parent POM,
+ you can set the option <<<autoVersionSubmodules>>> to <<<true>>>. Now you will
+ be asked only once for the release version and the next development version.
Modified: maven/release/trunk/maven-release-plugin/src/site/apt/examples/rollback-release.apt
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/site/apt/examples/rollback-release.apt?rev=895315&r1=895314&r2=895315&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/apt/examples/rollback-release.apt (original)
+++ maven/release/trunk/maven-release-plugin/src/site/apt/examples/rollback-release.apt Sun Jan 3 01:47:31 2010
@@ -1,9 +1,10 @@
------
- Rollback a release
+ Rollback a Release
------
Edwin Punzalan <ep...@apache.org>
------
- January 05, 2007
+ 2010-01-03
+ ------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -22,22 +23,27 @@
~~ specific language governing permissions and limitations
~~ under the License.
-Rollback a release
+Rollback a Release
+
+ To rollback a release, the following requirement must be met:
+
+ * You haven't run <<<release:clean>>> on the project. This means that the backup files and the release descriptor from the previous
+ release command still exists.
- To rollback a release, the following requirements should be met:
+ []
- * You haven't ran <<release:clean>> on the project so that the backup files and the release descriptor of the previous
- still exists.
+ When a release is rolled back, the following steps are executed:
- When a release is rolled back, the following are executed:
+ * All project POMs are reverted back to their pre-release state locally, and also in the SCM if the previous release
+ command was able to successfully make changes in the SCM to the POMs. This is done by using the backup files created during
+ <<<release:prepare>>>.
- * All project POMs are reverted back to their pre-release state locally and also in the SCM if the previous release
- command was able to successfully make changes in the SCM to the POMs using a backup created during
- <<release:prepare>>.
+ * The created branch/tag in SCM for the release is removed.
+ <<Note:>> This is not yet implemented so you will need to manually remove the branch/tag from your SCM.
- * The created branch/tag in SCM for the release is removed. <<not yet implemented>>
+ []
- To execute this step, run:
+ To rollback a release execute this command:
-------
mvn release:rollback
Modified: maven/release/trunk/maven-release-plugin/src/site/apt/examples/run-goals-before-commit.apt.vm
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/site/apt/examples/run-goals-before-commit.apt.vm?rev=895315&r1=895314&r2=895315&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/apt/examples/run-goals-before-commit.apt.vm (original)
+++ maven/release/trunk/maven-release-plugin/src/site/apt/examples/run-goals-before-commit.apt.vm Sun Jan 3 01:47:31 2010
@@ -1,11 +1,12 @@
------
- Run Goals Before Commit
+ Run Additional Goals Before Commit
------
Carlos Sanchez <ca...@apache.org>
Brett Porter <br...@apache.org>
John Tolentino <jt...@apache.org>
------
- September 18, 2006
+ 2010-01-03
+ ------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -24,7 +25,7 @@
~~ specific language governing permissions and limitations
~~ under the License.
-Run Goals Before Commit
+Run Additional Goals Before Commit
To run additional goals after release preparation but before committing, specify them using the <<<preparationGoals>>>
property.
Modified: maven/release/trunk/maven-release-plugin/src/site/apt/examples/update-versions.apt
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/site/apt/examples/update-versions.apt?rev=895315&r1=895314&r2=895315&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/apt/examples/update-versions.apt (original)
+++ maven/release/trunk/maven-release-plugin/src/site/apt/examples/update-versions.apt Sun Jan 3 01:47:31 2010
@@ -3,7 +3,8 @@
------
Paul Gier
------
- Sep 14, 2009
+ 2010-01-03
+ ------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -24,7 +25,7 @@
Updating POM Versions
- In some situations you may want an easy way to update the version numbers in each pom of a multi-module
+ In some situations you may want an easy way to update the version numbers in each POM of a multi-module
project. The <<<update-versions>>> goal is designed to accomplish this.
To update the version numbers in your POMs, run:
@@ -34,25 +35,24 @@
-------
You will be prompted for the version number for each module of the project. If you prefer that each module
- version be the same as the parent pom, you can use the option <<<autoVersionSubmodules>>>.
+ version be the same as the parent POM, you can use the option <<<autoVersionSubmodules>>>.
-------
mvn release:update-versions -DautoVersionSubmodules=true
-------
In this case you will only be prompted for the desired version number once.
-
-
+
+
* Specify versions on the command line.
You may want to specify the version(s) to use on the command line. This can be useful for example if you are running
- the update in non-interactive mode. The <<<update-versions>>> goal can use the same properties used by the prepare goal
+ the update in non-interactive mode. The <<<update-versions>>> goal can use the same properties used by the <<<prepare>>> goal
for specifying the versions to be used.
-
+
-----------
mvn --batch-mode release:update-versions -DdevelopmentVersion=1.2.0-SNAPSHOT
-----------
In this example, the local POM will be set to the version 1.2.0-SNAPSHOT
-
\ No newline at end of file
Modified: maven/release/trunk/maven-release-plugin/src/site/apt/index.apt
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/site/apt/index.apt?rev=895315&r1=895314&r2=895315&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/apt/index.apt (original)
+++ maven/release/trunk/maven-release-plugin/src/site/apt/index.apt Sun Jan 3 01:47:31 2010
@@ -5,7 +5,8 @@
Brett Porter <br...@apache.org>
John Tolentino <jt...@apache.org>
------
- September 18, 2006
+ 2010-01-03
+ ------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -37,13 +38,13 @@
* {{{./rollback-mojo.html}release:rollback}} Rollback a previous release.
- * {{{./perform-mojo.html}release:perform}} Perform a release from SCM
+ * {{{./perform-mojo.html}release:perform}} Perform a release from SCM.
- * {{{./stage-mojo.html}release:stage}} Perform a release from SCM into a staging folder/repository
+ * {{{./stage-mojo.html}release:stage}} Perform a release from SCM into a staging folder/repository.
* {{{./branch-mojo.html}release:branch}} Create a branch of the current project with all versions updated.
- * {{{./update-versions-mojo.html}release:udpate-versions}} Update the versions in the POM(s).
+ * {{{./update-versions-mojo.html}release:update-versions}} Update the versions in the POM(s).
* Usage
@@ -71,9 +72,11 @@
you can take a look into the following examples:
- * {{{./examples/perform-release.html}Perform Release}}
+ * {{{./examples/prepare-release.html}Prepare a Release}}
+
+ * {{{./examples/perform-release.html}Perform a Release}}
- * {{{./examples/prepare-release.html}Prepare Release}}
+ * {{{./examples/rollback-release.html}Rollback a Release}}
* {{{./examples/generate-release-poms.html}Generate Release POMs}}
@@ -83,7 +86,7 @@
* {{{./examples/branch.html}Create a Branch}}
- * {{{./examples/non-interactive-release.html}Non Interactive Release}}
+ * {{{./examples/non-interactive-release.html}Non-interactive Release}}
* {{{./examples/update-versions.html}Update POM Versions}}
Modified: maven/release/trunk/maven-release-plugin/src/site/apt/usage.apt.vm
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/site/apt/usage.apt.vm?rev=895315&r1=895314&r2=895315&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/apt/usage.apt.vm (original)
+++ maven/release/trunk/maven-release-plugin/src/site/apt/usage.apt.vm Sun Jan 3 01:47:31 2010
@@ -5,7 +5,8 @@
Brett Porter <br...@apache.org>
John Tolentino <jt...@apache.org>
------
- September 18, 2006
+ 2010-01-03
+ ------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
@@ -31,16 +32,16 @@
* 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 remote username, you may need to set the following option:
+ not the same as the SCM username, you may need to set the following option:
------
-mvn -Dusername=your_username release:prepare
+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 it is not needed if you use the standard SVN layout, where the root project is in <<<trunk>>>, and
+ 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.
-------------------
@@ -66,7 +67,7 @@
* 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
+ 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:
@@ -104,10 +105,10 @@
been tested IS the one that is deployed.
The <<<release:stage>>> goal uses this strategy. It replaces the <<<release:perform>>> goal and does the same
- tasks, but requires a <<<stagingRepository>>> parameter. It will automatically re-configure the deploy and
- site-deploy goals to use the staging strategy.
+ tasks, but requires a <<<stagingRepository>>> parameter. It will automatically re-configure the <<<deploy>>> and
+ <<<site-deploy>>> goals to use the staging strategy.
After the release is complete, the <<<release.properties>>> and other release files will NOT be removed, so that
- you can still execute a <<<release:rollback>>> if something wrong has been detected and a new candidate must
+ 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 tag.
+ if the SCM provider supports renaming tags.
Modified: maven/release/trunk/maven-release-plugin/src/site/site.xml
URL: http://svn.apache.org/viewvc/maven/release/trunk/maven-release-plugin/src/site/site.xml?rev=895315&r1=895314&r2=895315&view=diff
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/site.xml (original)
+++ maven/release/trunk/maven-release-plugin/src/site/site.xml Sun Jan 3 01:47:31 2010
@@ -43,13 +43,14 @@
<item name="FAQ" href="faq.html"/>
</menu>
<menu name="Examples">
- <item name="Perform Release" href="examples/perform-release.html"/>
- <item name="Prepare Release" href="examples/prepare-release.html"/>
+ <item name="Prepare a Release" href="examples/prepare-release.html"/>
+ <item name="Perform a Release" href="examples/perform-release.html"/>
+ <item name="Rollback a Release" href="examples/rollback-release.html"/>
<item name="Generate Release POMs" href="examples/generate-release-poms.html"/>
<item name="Lock Files During Release" href="examples/lock-files.html"/>
<item name="Run Additional Goals Before Commit" href="examples/run-goals-before-commit.html"/>
<item name="Create a Branch" href="examples/branch.html"/>
- <item name="Batch Mode Release" href="examples/non-interactive-release.html"/>
+ <item name="Non-interactive Release" href="examples/non-interactive-release.html"/>
<item name="Update POM Versions" href="examples/update-versions.html"/>
</menu>
</body>