You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@uima.apache.org by sc...@apache.org on 2010/10/28 16:47:05 UTC

svn commit: r1028333 - in /uima/site/trunk/uima-website: docs/staging/release.html xdocs/staging/release.xml

Author: schor
Date: Thu Oct 28 14:47:04 2010
New Revision: 1028333

URL: http://svn.apache.org/viewvc?rev=1028333&view=rev
Log:
[UIMA-1916] update release instructions for new method of building uima-build-resources.

Modified:
    uima/site/trunk/uima-website/docs/staging/release.html
    uima/site/trunk/uima-website/xdocs/staging/release.xml

Modified: uima/site/trunk/uima-website/docs/staging/release.html
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/docs/staging/release.html?rev=1028333&r1=1028332&r2=1028333&view=diff
==============================================================================
--- uima/site/trunk/uima-website/docs/staging/release.html (original)
+++ uima/site/trunk/uima-website/docs/staging/release.html Thu Oct 28 14:47:04 2010
@@ -180,6 +180,7 @@
 		<li><a href="#Release Discussions - Release Plan">Release Discussions - Release Plan</a></li>
     <li><a href="#Preparing Jira for the Release">Preparing Jira for the Release</a></li>
 		<li><a href="#Preparing The Sourcecode For The Release">Preparing The Sourcecode For The Release</a></li>
+		<li><a href="#Including updates to the Build tooling">Including updates to the Build tooling</a></li>
 		<li><a href="#Building The Release Candidate">Building The Release Candidate</a></li>
 		<li><a href="#Doing The Release Vote">Doing The Release Vote</a></li>
     <li><a href="#Ask Incubator PMC To Release">Ask Incubator PMC To Release</a></li>
@@ -353,6 +354,36 @@ mvn install</pre>
        
        
        
+          <a name="Including updates to the Build tooling">
+            <h2>Including updates to the Build tooling
+                        </h2>
+          </a>
+      </td></tr>
+      <tr><td>
+        <blockquote class="subsectionBody">
+                                    <p>This step is skipped, unless the build tooling is being updated.</p>
+                                                <p>There are two projects in the build tooling, each having as a parent, the common Apache Parent POM
+	<b>uima-build-resources</b> and <b>parent-pom</b>.
+	  The following special procedure is used to release updates to these.
+	</p>
+                                                <p>
+	  The parent-pom has the uima-build-resources's version number encoded as the 
+	  "property" <pre>&lt;uimaBuildResourcesVersion&gt;XXXXXX&lt;/uimaBuildResourcesVersion&gt;</pre>
+	  This value will normally be set to the last released version number of the uima-build-resources artifact.
+	</p>
+                                                <p>If that artifact is changing, during development, this will be set to the XX-SNAPSHOT value corresponding to 
+	   the development version.  When releasing, first do a release (to the Nexus Staging repository, as usual) of
+	   the uima-build-resources artifact, which will create a version without the -SNAPSHOT.  Then change the
+	   &lt;uimaBuildResourcesVersion&gt; value to correspond to the non-SNAPSHOT version number of this, before
+	   proceeding to release the parent-pom artifact.</p>
+                            </blockquote>
+        </td></tr>
+    </table>
+                                                      <table class="subsectionTable">
+        <tr><td>
+       
+       
+       
           <a name="Building The Release">
             <h2>Building The Release
                         </h2>
@@ -415,9 +446,10 @@ mvn install</pre>
       <tr><td>
         <blockquote class="subsectionBody">
                                     <p>
-      The release artifacts can refer to other artifacts in several ways, for example via the &lt;parent-pom&gt;
-      element, or via a &lt;dependency&gt; element.  Except for the docbook olink artifact, which is not released,
-      these dependencies should refer to non-snapshot versions of things.
+      POMs can refer to other artifacts in several ways, for example via the &lt;parent-pom&gt;
+      element, or via a &lt;dependency&gt; element.  References in these two elements are automatically updated
+      during the release process, from xx-SNAPSHOT to xx for the tag, and then to the next development level,
+      for the trunk.  So, no manual maintenance of these is needed; let the release plugin do this work. 
     </p>
                             </blockquote>
         </td></tr>
@@ -451,26 +483,6 @@ mvn install</pre>
        
        
        
-          <a name="Releasing build tooling">
-            <h2>Releasing build tooling
-                        </h2>
-          </a>
-      </td></tr>
-      <tr><td>
-        <blockquote class="subsectionBody">
-                                    <p>
-      Build tooling is released, project by project - each component in the build has its
-      own release version number, numbered sequentially starting with 1, as is the convention
-      in other Apache projects for build tooling.
-    </p>
-                            </blockquote>
-        </td></tr>
-    </table>
-                                                      <table class="subsectionTable">
-        <tr><td>
-       
-       
-       
           <a name="Releasing">
             <h2>Releasing
                         </h2>

Modified: uima/site/trunk/uima-website/xdocs/staging/release.xml
URL: http://svn.apache.org/viewvc/uima/site/trunk/uima-website/xdocs/staging/release.xml?rev=1028333&r1=1028332&r2=1028333&view=diff
==============================================================================
--- uima/site/trunk/uima-website/xdocs/staging/release.xml (original)
+++ uima/site/trunk/uima-website/xdocs/staging/release.xml Thu Oct 28 14:47:04 2010
@@ -40,7 +40,8 @@ under the License.
     <li><a href="#Overview">Overview of releasing</a></li>
 		<li><a href="#Release Discussions - Release Plan">Release Discussions - Release Plan</a></li>
     <li><a href="#Preparing Jira for the Release">Preparing Jira for the Release</a></li>
-		<li><a href="#Preparing The Sourcecode For The Release">Preparing The Sourcecode For The Release</a></li>
+		<li><a href="#Preparing The Sourcecode For The Release">Preparing The Sourcecode For The Release</a></li>
+		<li><a href="#Including updates to the Build tooling">Including updates to the Build tooling</a></li>
 		<li><a href="#Building The Release Candidate">Building The Release Candidate</a></li>
 		<li><a href="#Doing The Release Vote">Doing The Release Vote</a></li>
     <li><a href="#Ask Incubator PMC To Release">Ask Incubator PMC To Release</a></li>
@@ -164,6 +165,24 @@ mvn install</pre>
         </li>
 		  </ul>
 		</p>
+	</subsection>
+	
+	<subsection name="Including updates to the Build tooling">
+	<p>This step is skipped, unless the build tooling is being updated.</p>
+	<p>There are two projects in the build tooling, each having as a parent, the common Apache Parent POM
+	<b>uima-build-resources</b> and <b>parent-pom</b>.
+	  The following special procedure is used to release updates to these.
+	</p>
+	<p>
+	  The parent-pom has the uima-build-resources's version number encoded as the 
+	  "property" <pre>&lt;uimaBuildResourcesVersion>XXXXXX&lt;/uimaBuildResourcesVersion></pre>
+	  This value will normally be set to the last released version number of the uima-build-resources artifact.
+	</p>
+	<p>If that artifact is changing, during development, this will be set to the XX-SNAPSHOT value corresponding to 
+	   the development version.  When releasing, first do a release (to the Nexus Staging repository, as usual) of
+	   the uima-build-resources artifact, which will create a version without the -SNAPSHOT.  Then change the
+	   &lt;uimaBuildResourcesVersion> value to correspond to the non-SNAPSHOT version number of this, before
+	   proceeding to release the parent-pom artifact.</p>	
 	</subsection>
 	
 	<subsection name='Building The Release'>
@@ -217,9 +236,10 @@ mvn install</pre>
 	
   <subsection name='Removing -SNAPSHOT dependencies'>
     <p>
-      The release artifacts can refer to other artifacts in several ways, for example via the &lt;parent-pom>
-      element, or via a &lt;dependency> element.  Except for the docbook olink artifact, which is not released,
-      these dependencies should refer to non-snapshot versions of things.
+      POMs can refer to other artifacts in several ways, for example via the &lt;parent-pom>
+      element, or via a &lt;dependency> element.  References in these two elements are automatically updated
+      during the release process, from xx-SNAPSHOT to xx for the tag, and then to the next development level,
+      for the trunk.  So, no manual maintenance of these is needed; let the release plugin do this work. 
     </p>
   </subsection>
   
@@ -234,15 +254,7 @@ mvn install</pre>
       
 		</p>
 	</subsection>
-  
-  <subsection name='Releasing build tooling'>
-    <p>
-      Build tooling is released, project by project - each component in the build has its
-      own release version number, numbered sequentially starting with 1, as is the convention
-      in other Apache projects for build tooling.
-    </p>    
-  </subsection>
-
+  
 	<subsection name='Releasing'>
 		<p>
 		  After a successful release vote for the release on the dev mailing list log on to the