You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ch...@apache.org on 2018/04/17 12:26:52 UTC

svn commit: r1829360 - /commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml

Author: chtompki
Date: Tue Apr 17 12:26:52 2018
New Revision: 1829360

URL: http://svn.apache.org/viewvc?rev=1829360&view=rev
Log:
(docs) including notes on release-plugin in parent documentation

Modified:
    commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml

Modified: commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml
URL: http://svn.apache.org/viewvc/commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml?rev=1829360&r1=1829359&r2=1829360&view=diff
==============================================================================
--- commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml (original)
+++ commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml Tue Apr 17 12:26:52 2018
@@ -31,11 +31,11 @@
         <a href="http://svn.apache.org/repos/asf/commons/proper/commons-parent/trunk/pom.xml">commons-parent</a>
         <code>pom.xml</code>
         <br/>
-        It has been updated for version 42 of the pom (but some discrepancies may remain).
-        Please consult <a href="http://svn.apache.org/repos/asf/commons/proper/commons-parent/tags/commons-parent-42/">version 41 source</a>
+        It has been updated for version 46 of the pom (but some discrepancies may remain).
+        Please consult <a href="http://svn.apache.org/repos/asf/commons/proper/commons-parent/tags/commons-parent-46/">version 46 source</a>
         in case of doubt.
         <br/>
-        Release Notes for <a href="http://svn.apache.org/repos/asf/commons/proper/commons-parent/tags/commons-parent-42/RELEASE-NOTES.txt">version 41</a>
+        Release Notes for <a href="http://svn.apache.org/repos/asf/commons/proper/commons-parent/tags/commons-parent-46/RELEASE-NOTES.txt">version 46</a>
       </p>
 
       <p>
@@ -146,6 +146,31 @@
           produced when  generating a component's site. The <a href="http://incubator.apache.org/rat/">RAT</a> report
           checks the source files for appropriate <a href="http://www.apache.org/legal/src-headers.html">License Headers</a>.
         </p>
+
+        <p><strong>Commons Release Plugin.</strong></p>
+
+        <p>
+          By default in the parent, the <a href="/proper/commons-release-plugin/index.html">commons-release-plugin</a>
+          is disabled as to not stop folks' release practices. That said, for people interested in configuring the
+          newly released (April 2018) release plugin, one needs to configure the following properties, for single
+          module builds:
+          <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.
+        </p>
       </subsection>
 
       <subsection name="Site Generation">