svn commit: r1421829 - /isis/site/trunk/content/contributors/release-branch-and-tag-names.md

[da...@apache.org]

Author: danhaywood
Date: Fri Dec 14 12:49:09 2012
New Revision: 1421829

URL: http://svn.apache.org/viewvc?rev=1421829&view=rev
Log:
isis site : refining release process docs

Modified:
    isis/site/trunk/content/contributors/release-branch-and-tag-names.md

Modified: isis/site/trunk/content/contributors/release-branch-and-tag-names.md
URL: http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/release-branch-and-tag-names.md?rev=1421829&r1=1421828&r2=1421829&view=diff
==============================================================================
--- isis/site/trunk/content/contributors/release-branch-and-tag-names.md (original)
+++ isis/site/trunk/content/contributors/release-branch-and-tag-names.md Fri Dec 14 12:49:09 2012
@@ -6,20 +6,28 @@ In Isis the version numbers of core and 
 (they are not synchronized); therefore the branches and the tag names must 
 distinguish the releasable module that they refer to.
 
-Usefully, git allows the same name to be used for both branches and for tags; within git they are namespaced to be unique.  The table below shows the branch name to use when readying the release locally, and the tag name to use when running the `release:prepare` command itself; as you can see they are identical.  As we've chosen to base the branch/tag name on the `artifactId` of the pom of the parent module being released, they also happen to be the defaults provided by the `maven-release-plugin`:
+The table below shows the tag name to use when running the `release:prepare` command itself, as well as the local branch name to use while preparing the release:
+
+* We've chosen to base the tag name on the `artifactId` of the pom of the parent module being released, as this also happens to be the default provided by the `maven-release-plugin`.  
+
+* The branch name to use is not actually that important, because it would not usually be pushed to the origin (unless you were preparing the release with some other committer).  However, we recommend that is similar (though not identical to) the tag name. 
+
+{note
+In fact, git allows the same name to be used for both branches and for tags; within git they are namespaced to be unique.  However, using the same name for the branch confuses `maven-release-plugin`; thus the branch name is slightly different from the tag name.
+}
 
 <table>
 <tr>
 <th>Releasable module</th>
 <th>Branch name to use while readying the release locally</th>
-<th>Tag name pushed during <tt>release:prepare</tt></th>
+<th>Tag name pushed.</th>
 </tr>
-<tr><td>core</td><td>isis-x.y.z</td><td>isis-x.y.z</td></tr>
-<tr><td>objectstore/xxx</td><td>isis-objectstore-xxx-x.y.z</td><td>isis-objectstore-xxx-x.y.z</td></tr>
-<tr><td>profilestore/xxx</td><td>isis-profilestore-xxx-x.y.z</td><td>isis-profilestore-xxx-x.y.z</td></tr>
-<tr><td>progmodel/xxx</td><td>isis-progmodel-xxx-x.y.z</td><td>isis-progmodel-xxx-x.y.z</td></tr>
-<tr><td>security/xxx</td><td>isis-security-xxx-x.y.z</td><td>isis-security-xxx-x.y.z</td></tr>
-<tr><td>viewer/xxx</td><td>isis-viewer-xxx-x.y.z</td><td>isis-viewer-xxx-x.y.z</td></tr>
+<tr><td>core</td><td>prepare/isis-x.y.z</td><td>isis-x.y.z</td></tr>
+<tr><td>objectstore/xxx</td><td>prepare/isis-objectstore-xxx-x.y.z</td><td>isis-objectstore-xxx-x.y.z</td></tr>
+<tr><td>profilestore/xxx</td><td>prepare/isis-profilestore-xxx-x.y.z</td><td>isis-profilestore-xxx-x.y.z</td></tr>
+<tr><td>progmodel/xxx</td><td>prepare/isis-progmodel-xxx-x.y.z</td><td>isis-progmodel-xxx-x.y.z</td></tr>
+<tr><td>security/xxx</td><td>prepare/isis-security-xxx-x.y.z</td><td>isis-security-xxx-x.y.z</td></tr>
+<tr><td>viewer/xxx</td><td>prepare/isis-viewer-xxx-x.y.z</td><td>isis-viewer-xxx-x.y.z</td></tr>
 </table>
 
 where `xxx` represents a specific component or archetype being released.