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

[gg...@apache.org]

Author: ggregory
Date: Mon Jul 16 21:28:20 2018
New Revision: 1836070

URL: http://svn.apache.org/viewvc?rev=1836070&view=rev
Log:
Better RC review guidelines.

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=1836070&r1=1836069&r2=1836070&view=diff
==============================================================================
--- commons/cms-site/trunk/content/xdoc/releases/prepare.xml (original)
+++ commons/cms-site/trunk/content/xdoc/releases/prepare.xml Mon Jul 16 21:28:20 2018
@@ -864,11 +864,40 @@ Lucky RM </pre>
     There are a number of common things that releases fail on.
     </p>
 
+    <subsection name="Downloads">
+    <p>Check the validity of what you download:</p>
+    <ul>
+      <li>Verify the ASC file with <code>gpg --verify FILE.asc</code></li>
+    </ul>
+    <p>There should be at least one SHA file:</p>
+    <ul>
+      <li>Verify the SHA-1 file if any with <code>sha1sum FILE.zip/gz</code> and compare with the actual <code>FILE.zip/gz.sha1</code> file</li>
+      <li>Verify the SHA-256 file if any with <code>sha256sum FILE.zip/gz</code> and compare with the actual <code>FILE.zip/gz.sha256</code> file</li>
+      <li>Verify the SHA-512 file if any with <code>sha256sum FILE.zip/gz</code> and compare with the actual <code>FILE.zip/gz.sha512</code> file</li>
+    </ul>
+    </subsection>
+
+    <subsection name="Licensing">
+    <ul>
+      <li>The NOTICE.txt file must be included in both the distribution tars/zips and the included jars.</li>
+      <li>In NOTICE.txt, the end year of the copright notice is the current year.</li>
+      <li>Check the <a href="http://creadur.apache.org/rat/apache-rat-plugin/">RAT</a> report or run it with <code>mvn apache-rat:check</code></li>
+    </ul>
+    <p>
+    Maven builds default to including this, so no further effort is required
+    for those projects.
+    </p>
+    </subsection>
+    
     <subsection name="API Changes">
     <p>
       Accidental non-compatible API changes in a minor release. The clirr report
       generated by Maven is very useful in spotting these.
     </p>
+    <ul>
+       <li>You can check the site's <a href="http://www.mojohaus.org/clirr-maven-plugin/">Clirr</a> report or run it yourself with <code>mvn clirr:check</code></li>
+       <li>You can check the site's <a href="https://github.com/siom79/japicmp">Japicmp</a> report or run it yourself with <code>mvn japicmp:cmp</code></li>
+    </ul>
     </subsection>
 
     <subsection name="Javadoc">
@@ -918,16 +947,6 @@ Lucky RM </pre>
     </p>
     </subsection>
 
-    <subsection name="Licensing">
-    <p>
-    The NOTICE.txt file must be included in both the distribution tars/zips and the
-    included jars.
-    </p>
-    <p>
-    Maven builds default to including this, so no further effort is required
-    for those projects.
-    </p>
-    </subsection>
   </section>
 
   <section name="What next?">