Author: evenisse
Date: Wed May 16 13:30:24 2007
New Revision: 538718
URL: http://svn.apache.org/viewvc?view=rev&rev=538718
Log:
Add doc for the branch goal
Added:
maven/release/trunk/maven-release-plugin/src/site/apt/examples/branch.apt
(with props)
Modified:
maven/release/trunk/maven-release-plugin/src/site/apt/index.apt
maven/release/trunk/maven-release-plugin/src/site/site.xml
Added: 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?view=auto&rev=538718
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/apt/examples/branch.apt
(added)
+++ maven/release/trunk/maven-release-plugin/src/site/apt/examples/branch.apt
Wed May 16 13:30:24 2007
@@ -0,0 +1,56 @@
+ ------
+ Create a branch
+ ------
+ Emmanuel Venisse <[EMAIL PROTECTED]>
+ ------
+ May 16, 2007
+
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+
+Create a branch
+
+ Creating a branch executes 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)
+
+ * Transform the SCM information in the POM to include the final destination
of the tag
+
+ * Commit the modified POMs
+
+ * Tag the code in the SCM as a new branch with a version name (this will be
prompted for)
+
+ * Bump the version in the POMs if you want to change it to a new value
y-SNAPSHOT (these values will also be prompted for)
+
+ * Commit the modified POMs
+
+ To execute this step, run:
+
+-------
+mvn release:branch
+-------
+
+ By default, versions in the new branch aren't modified and versions in the
actual branch are updated. If you want to update versions
+ in the new branch and not in the actual, run:
+
+-------
+mvn release:branch -DupdateBranchVersions=true
-DupdateWorkingCopyVersions=false
+-------
+
+ <<Note:>> It can be useful if you want to create a branch from a tag
Propchange:
maven/release/trunk/maven-release-plugin/src/site/apt/examples/branch.apt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange:
maven/release/trunk/maven-release-plugin/src/site/apt/examples/branch.apt
------------------------------------------------------------------------------
svn:keywords = "Author Date Id Revision"
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?view=diff&rev=538718&r1=538717&r2=538718
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/apt/index.apt (original)
+++ maven/release/trunk/maven-release-plugin/src/site/apt/index.apt Wed May 16
13:30:24 2007
@@ -37,7 +37,9 @@
* {{{prepare-mojo.html}release:prepare}} Prepare for a release in SCM.
- * {{{rollback-mojo.html}release:rollback}} Rollback a previous relase.
+ * {{{rollback-mojo.html}release:rollback}} Rollback a previous release.
+
+ * {{{branch-mojo.html}release:branch}} Create a branch of the current
project with all versions updated.
* Usage
@@ -59,4 +61,4 @@
* {{{examples/run-goals-before-commit.html}Run Additional Goals Before
Commit}}
-
+ * {{{examples/branch.html}Create a branch}}
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?view=diff&rev=538718&r1=538717&r2=538718
==============================================================================
--- maven/release/trunk/maven-release-plugin/src/site/site.xml (original)
+++ maven/release/trunk/maven-release-plugin/src/site/site.xml Wed May 16
13:30:24 2007
@@ -68,6 +68,7 @@
<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"/>
</menu>
<menu ref="reports" inherit="bottom" />
</body>
