svn commit: r1829549 - /commons/cms-site/trunk/content/xdoc/releases/prepare.xml

[ch...@apache.org]

Author: chtompki
Date: Thu Apr 19 14:48:50 2018
New Revision: 1829549

URL: http://svn.apache.org/viewvc?rev=1829549&view=rev
Log:
(docs) adding release-plugin documentation to preparing releases

Modified:
    commons/cms-site/trunk/content/xdoc/releases/prepare.xml

Modified: commons/cms-site/trunk/content/xdoc/releases/prepare.xml
URL: http://svn.apache.org/viewvc/commons/cms-site/trunk/content/xdoc/releases/prepare.xml?rev=1829549&r1=1829548&r2=1829549&view=diff
==============================================================================
--- commons/cms-site/trunk/content/xdoc/releases/prepare.xml (original)
+++ commons/cms-site/trunk/content/xdoc/releases/prepare.xml Thu Apr 19 14:48:50 2018
@@ -619,7 +619,36 @@ mvn versions:display-plugin-updates -U</
       <em>TODO:</em> Does the Maven Release plugin work with git?
 
     </subsection>
-    <subsection name="Create the Release Candidate">
+
+    <subsection name="Create the Release Candidate with the Commons Release Plugin.">
+      The <a href="commons-release-plugin/index.html">Commons Release Plugin</a>, as of
+      commons-parent-46 is included but disabled. Note, as of version 1.2 of the plugin and version
+      46 of the parent, we have throughly tested single module builds, but multi-module builds remain
+      an open problem (which may work, but at the time of writing have not been fully vetted). To
+      enable the plugin, one needs to configure the <code>properties</code> section of the pom as follows:
+      <pre class="prettyprint"><![CDATA[
+<properties>
+    <commons.release.isDistModule>true</commons.release.isDistModule>
+    <commons.distSvnStagingUrl>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</commons.distSvnStagingUrl>
+</properties>]]></pre>
+      where <code>foo</code> represents our component. Furthermore, during a release build, we ask that the svn
+      folder be empty. We then generate our release build by runnning:
+      <pre>
+        mvn -Duser.name=${my_apache_id} -Prelease -Ptest-deploy clean package site deploy</pre>
+      to test our deployment. Note, all of the staged items end up in
+      <code>target/commons-release-plugin/scm</code>. And, to perform a full release, we run:
+      <pre>
+        mvn -Duser.name=${my_apache_id} -Prelease clean package site deploy</pre>
+      Using the release plugin should build and stage the non-assembly built artifacts to Nexus, and stage
+      the assemblies to the svn location along with the site and the <code>RELEASE-NOTES.txt</code> from the
+      root of the project.
+
+      After finishing the build you will need to "close" the staging repository in the
+      <a href="https://repository.apache.org">Apache Nexus instance</a>. You can then continue down
+      to <a href="#Voting_On_Release">preparing the vote</a> below to prepare the vote.
+    </subsection>
+
+    <subsection name="Create the Release Candidate Manually">
 
     <p>
     Build distributions from a fresh checkout of the RC tag.