Merge tag 'commons-release-plugin-1.3'

Promoting commons-release-plugin-1.3 RC1
apache · Jun 19, 2018 · b08def7 · b08def7
2 parents ab72bbd + 7fc141f
commit b08def7
Show file tree

Hide file tree

Showing 10 changed files with 175 additions and 79 deletions.
diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt
@@ -1,10 +1,10 @@
                          Apache Commons Release Plugin
-                                  Version 1.2
+                                  Version 1.3
                                  Release Notes
 
 INTRODUCTION
 ============
-This document contains the release notes for the 1.2 version of Apache commons-release-plgin.
+This document contains the release notes for the 1.3 version of Apache commons-release-plgin.
 The commons-release-plugin is meant to be a mechanism for automating The Apache Commons Project's
 release process.
 
@@ -15,6 +15,26 @@ together for the purpose of removing the manual steps required to produce an Apa
 
 Changes in this version include:
 
+
+NEW FEATURES
+============
+o COMMONSSITE-112:  Add a vote.txt file.
+o COMMONSSITE-108:  Adding README.html and HEADER.html to staged release
+
+
+CHANGES
+=======
+o COMMONSSITE-117: Remove md5 signatures from release artifacts.
+o COMMONSSITE-113: Put unpacked site in scm dev dist directory for navigating purposes.
+o Update platform requirement from Java 7 to Java 8.
+
+
+=============================================================================
+
+                         Apache Commons Release Plugin
+                                  Version 1.2
+                                 Release Notes
+
 FIXED BUGS
 ==========
 
@@ -25,7 +45,7 @@ o COMMONSSITE-107: Adding ./target/commons-release-plugin/scm/RELEASE-NOTES.txt
 =============================================================================
 
                          Apache Commons Release Plugin
-                                  Version 1.0
+                                  Version 1.1
                                  Release Notes
 
 NEW FEATURES

diff --git a/pom.xml b/pom.xml
@@ -25,7 +25,7 @@
   </parent>
   <artifactId>commons-release-plugin</artifactId>
   <packaging>maven-plugin</packaging>
-  <version>1.3-SNAPSHOT</version>
+  <version>1.3</version>
   <name>Apache Commons Release Plugin</name>
 
   <description>
@@ -108,6 +108,15 @@
     <project.build.sourceEncoding>${commons.encoding}</project.build.sourceEncoding>
     <!-- This is used by reporting plugins -->
     <project.reporting.outputEncoding>${commons.encoding}</project.reporting.outputEncoding>
+
+    <!-- Including commons release plugin older version -->
+    <commons.release.isDistModule>true</commons.release.isDistModule>
+    <commons.bc.version>1.2</commons.bc.version>
+    <commons.release.version>1.3</commons.release.version>
+    <commons.rc.version>RC1</commons.rc.version>
+    <commons.release.isDistModule>true</commons.release.isDistModule>
+    <commons.releaseManagerName>Rob Tompkins</commons.releaseManagerName>
+    <commons.releaseManagerKey>B6E73D84EA4FCC47166087253FAAD2CD5ECBB314</commons.releaseManagerKey>
   </properties>
 
   <dependencies>
@@ -428,7 +437,7 @@
       <plugin>
         <groupId>org.apache.commons</groupId>
         <artifactId>commons-release-plugin</artifactId>
-        <version>1.1</version>
+        <version>${commons.release-plugin.version}</version>
         <configuration>
           <distSvnStagingUrl>scm:svn:https://dist.apache.org/repos/dist/dev/commons/commons-release-plugin
           </distSvnStagingUrl>
@@ -441,13 +450,6 @@
               <goal>detach-distributions</goal>
             </goals>
           </execution>
-          <execution>
-            <id>compress-site</id>
-            <phase>site</phase>
-            <goals>
-              <goal>compress-site</goal>
-            </goals>
-          </execution>
           <execution>
             <id>stage-distributions</id>
             <phase>deploy</phase>

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
@@ -25,7 +25,8 @@
   </properties>
 
   <body>
-    <release version="1.3" date="YYYY-MM-DD" description="TBD">
+    <release version="1.3" date="2018-06-15" description="Version 1.3">
+      <action issue="COMMONSSITE-117" type="update" dev="chtompki">Remove md5 signatures from release artifacts.</action>
       <action issue="COMMONSSITE-113" type="update" dev="chtompki">Put unpacked site in scm dev dist directory for navigating purposes.</action>
       <action issue="COMMONSSITE-112" type="add" dev="ggregory">Add a vote.txt file.</action>
       <action issue="COMMONSSITE-108" type="add" dev="chtompki">Adding README.html and HEADER.html to staged release</action>

diff --git a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.java b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionDetachmentMojo.java
@@ -159,14 +159,9 @@ public void execute() throws MojoExecutionException {
      */
     private void putAttachedArtifactInSha1Map(Artifact artifact) throws MojoExecutionException {
         try {
-            StringBuffer artifactKey = new StringBuffer();
-            artifactKey
-                .append(artifact.getArtifactId()).append('-')
-                .append(artifact.getVersion()).append('-')
-                .append(artifact.getClassifier()).append('-')
-                .append(artifact.getType());
+            String artifactKey = getArtifactKey(artifact);
             try (FileInputStream fis = new FileInputStream(artifact.getFile())) {
-                artifactSha1s.put(artifactKey.toString(), DigestUtils.sha1Hex(fis));
+                artifactSha1s.put(artifactKey, DigestUtils.sha1Hex(fis));
             }
         } catch (IOException e) {
             throw new MojoExecutionException(
@@ -190,14 +185,9 @@ private void putAttachedArtifactInSha1Map(Artifact artifact) throws MojoExecutio
      */
     private void putAttachedArtifactInSha256Map(Artifact artifact) throws MojoExecutionException {
         try {
-            StringBuffer artifactKey = new StringBuffer();
-            artifactKey
-                .append(artifact.getArtifactId()).append('-')
-                .append(artifact.getVersion()).append('-')
-                .append(artifact.getClassifier()).append('-')
-                .append(artifact.getType());
+            String artifactKey = getArtifactKey(artifact);
             try (FileInputStream fis = new FileInputStream(artifact.getFile())) {
-                artifactSha256s.put(artifactKey.toString(), DigestUtils.sha256Hex(fis));
+                artifactSha256s.put(artifactKey, DigestUtils.sha256Hex(fis));
             }
         } catch (IOException e) {
             throw new MojoExecutionException(
@@ -277,22 +267,9 @@ private void copyRemovedArtifactsToWorkingDirectory() throws MojoExecutionExcept
     private void hashArtifacts() throws MojoExecutionException {
         for (Artifact artifact : detachedArtifacts) {
             if (!artifact.getFile().getName().contains("asc")) {
-                StringBuffer artifactKey = new StringBuffer();
-                artifactKey.append(artifact.getArtifactId()).append('-')
-                        .append(artifact.getVersion()).append('-')
-                        .append(artifact.getClassifier()).append('-')
-                        .append(artifact.getType());
+                String artifactKey = getArtifactKey(artifact);
                 try {
-                    // MD5
                     String digest;
-                    try (FileInputStream fis = new FileInputStream(artifact.getFile())) {
-                        digest = DigestUtils.md5Hex(fis);
-                    }
-                    getLog().info(artifact.getFile().getName() + " md5: " + digest);
-                    try (PrintWriter printWriter = new PrintWriter(
-                            getMd5FilePath(workingDirectory, artifact.getFile()))) {
-                        printWriter.println(digest);
-                    }
                     // SHA-1
                     digest = artifactSha1s.getProperty(artifactKey.toString());
                     getLog().info(artifact.getFile().getName() + " sha1: " + digest);
@@ -358,4 +335,22 @@ private String getSha256FilePath(File directory, File file) {
         buffer.append(".sha256");
         return buffer.toString();
     }
+
+    /**
+     * Generates the unique artifact key for storage in our sha1 map and sha256 map. For example,
+     * commons-test-1.4-src.tar.gz should have it's name as the key.
+     *
+     * @param artifact the {@link Artifact} that we wish to generate a key for.
+     * @return the generated key
+     */
+    private String getArtifactKey(Artifact artifact) {
+        StringBuffer artifactKey = new StringBuffer();
+        artifactKey.append(artifact.getArtifactId()).append('-')
+                .append(artifact.getVersion()).append('-');
+        if (artifact.hasClassifier()) {
+            artifactKey.append(artifact.getClassifier()).append('-');
+        }
+        artifactKey.append(artifact.getType());
+        return artifactKey.toString();
+    }
 }
diff --git a/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.java b/src/main/java/org/apache/commons/release/plugin/mojos/CommonsDistributionStagingMojo.java
@@ -193,7 +193,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             getLog().info("Checking out dist from: " + distSvnStagingUrl);
             provider.checkOut(repository, scmFileSet);
             File copiedReleaseNotes = copyReleaseNotesToWorkingDirectory();
-            List<File> filesToCommit = copyDistributionsIntoScmDirectoryStructureAndAddToSvn(copiedReleaseNotes,
+            copyDistributionsIntoScmDirectoryStructureAndAddToSvn(copiedReleaseNotes,
                     provider, repository);
             List<File> filesToAdd = new ArrayList<>();
             listNotHiddenFilesAndDirectories(distCheckoutDirectory, filesToAdd);
@@ -271,20 +271,23 @@ private File copyReleaseNotesToWorkingDirectory() throws MojoExecutionException
      * Copies the list of files at the root of the {@link CommonsDistributionStagingMojo#workingDirectory} into
      * the directory structure of the distribution staging repository. Specifically:
      * <ul>
-     *     <li>root:</li>
+     *   <li>root:
      *     <ul>
      *         <li>site</li>
      *         <li>site.zip</li>
      *         <li>RELEASE-NOTES.txt</li>
-     *         <li>source:</li>
-     *         <ul>
+     *         <li>source:
+     *           <ul>
      *             <li>-src artifacts....</li>
-     *         </ul>
-     *         <li>binaries:</li>
-     *         <ul>
+     *           </ul>
+     *         </li>
+     *         <li>binaries:
+     *           <ul>
      *             <li>-bin artifacts....</li>
-     *         </ul>
+     *           </ul>
+     *         </li>
      *     </ul>
+     *   </li>
      * </ul>
      *
      * @param copiedReleaseNotes is the RELEASE-NOTES.txt file that exists in the

diff --git a/src/site/resources/release-notes/RELEASE-NOTES-1.3.txt b/src/site/resources/release-notes/RELEASE-NOTES-1.3.txt
@@ -0,0 +1,88 @@
+                         Apache Commons Release Plugin
+                                  Version 1.3
+                                 Release Notes
+
+INTRODUCTION
+============
+This document contains the release notes for the 1.3 version of Apache commons-release-plgin.
+The commons-release-plugin is meant to be a mechanism for automating The Apache Commons Project's
+release process.
+
+The Apache Commons Release Plugin is a collection of Java based Maven mojos for Apache Commons
+Release process. These mojos are intended to be used as a collection of steps to be strung
+together for the purpose of removing the manual steps required to produce an Apache Commons Release.
+
+
+Changes in this version include:
+
+
+NEW FEATURES
+============
+o COMMONSSITE-112:  Add a vote.txt file.
+o COMMONSSITE-108:  Adding README.html and HEADER.html to staged release
+
+
+CHANGES
+=======
+o COMMONSSITE-113: Put unpacked site in scm dev dist directory for navigating purposes.
+o Update platform requirement from Java 7 to Java 8.
+
+
+=============================================================================
+
+                         Apache Commons Release Plugin
+                                  Version 1.2
+                                 Release Notes
+
+FIXED BUGS
+==========
+
+o COMMONSSITE-107: Adding ./target/commons-release-plugin/scm/RELEASE-NOTES.txt
+                   to svn as opposed to ./RELEASE-NOTES.txt
+
+
+=============================================================================
+
+                         Apache Commons Release Plugin
+                                  Version 1.1
+                                 Release Notes
+
+NEW FEATURES
+============
+
+o COMMONSSITE-98:  Making the project more multi-module compatible
+
+FIXED BUGS
+==========
+
+o COMMONSSITE-104: Sha1 signature files now reflect actual signatures.
+o COMMONSSITE-102: Commons Release Plugin doesn't work with Commons Release Plugin
+o COMMONSSITE-101: Make -Dcommons.release.dryRun=true our commit toggle
+
+
+
+=============================================================================
+
+                         Apache Commons Release Plugin
+                                  Version 1.0
+                                 Release Notes
+
+NEW FEATURES
+============
+
+o COMMONSSITE-96:   Create commons-release-component project skeleton.
+o COMMONSSITE-99:   Prepare Standard Build integrations, travis, jacoco, checkstyle, etc.
+o COMMONSSITE-97:   Documentation for commons-release-plugin.
+
+
+Historical list of changes: http://commons.apache.org/release-plugin/changes-report.html
+
+For complete information on the Apache commons-release-plugin, including instructions on how
+to submit bug reports, patches, or suggestions for improvement, see the Apache commons-release-plugin's
+website:
+
+http://commons.apache.org/release-plugin/
+
+Have fun!
+-Apache Commons Release Plugin team
+
diff --git a/src/site/xdoc/download_commons-release-plugin.xml b/src/site/xdoc/download_commons-release-plugin.xml
@@ -102,7 +102,7 @@ limitations under the License.
         It is essential that you
         <a href="https://www.apache.org/info/verification.html">verify the integrity</a>
         of downloaded files, preferably using the <code>PGP</code> signature (<code>*.asc</code> files);
-        failing that using the <code>SHA1</code> hash (<code>*.sha1</code> checksum files).
+        failing that using the <code>SHA256</code> hash (<code>*.sha256</code> checksum files).
       </p>
       <p>
         The <a href="https://www.apache.org/dist/commons/KEYS">KEYS</a>
@@ -111,32 +111,32 @@ limitations under the License.
       </p>
     </subsection>
     </section>
-    <section name="Apache Commons Release Plugin 1.1 ">
+    <section name="Apache Commons Release Plugin 1.3 ">
       <subsection name="Binaries">
         <table>
           <tr>
-              <td><a href="[preferred]/commons/commons-release-plugin/binaries/commons-release-plugin-1.1-bin.tar.gz">commons-release-plugin-1.1-bin.tar.gz</a></td>
-              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.1-bin.tar.gz.sha1">sha1</a></td>
-              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.1-bin.tar.gz.asc">pgp</a></td>
+              <td><a href="[preferred]/commons/commons-release-plugin/binaries/commons-release-plugin-1.3-bin.tar.gz">commons-release-plugin-1.3-bin.tar.gz</a></td>
+              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.3-bin.tar.gz.sha256">sha256</a></td>
+              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.3-bin.tar.gz.asc">pgp</a></td>
           </tr>
           <tr>
-              <td><a href="[preferred]/commons/commons-release-plugin/binaries/commons-release-plugin-1.1-bin.zip">commons-release-plugin-1.1-bin.zip</a></td>
-              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.1-bin.zip.sha1">sha1</a></td>
-              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.1-bin.zip.asc">pgp</a></td>
+              <td><a href="[preferred]/commons/commons-release-plugin/binaries/commons-release-plugin-1.3-bin.zip">commons-release-plugin-1.3-bin.zip</a></td>
+              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.3-bin.zip.sha256">sha256</a></td>
+              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.3-bin.zip.asc">pgp</a></td>
           </tr>
         </table>
       </subsection>
       <subsection name="Source">
         <table>
           <tr>
-              <td><a href="[preferred]/commons/commons-release-plugin/source/commons-release-plugin-1.1-src.tar.gz">commons-release-plugin-1.1-src.tar.gz</a></td>
-              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.1-src.tar.gz.sha1">sha1</a></td>
-              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.1-src.tar.gz.asc">pgp</a></td>
+              <td><a href="[preferred]/commons/commons-release-plugin/source/commons-release-plugin-1.3-src.tar.gz">commons-release-plugin-1.3-src.tar.gz</a></td>
+              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.3-src.tar.gz.sha256">sha256</a></td>
+              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.3-src.tar.gz.asc">pgp</a></td>
           </tr>
           <tr>
-              <td><a href="[preferred]/commons/commons-release-plugin/source/commons-release-plugin-1.1-src.zip">commons-release-plugin-1.1-src.zip</a></td>
-              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.1-src.zip.sha1">sha1</a></td>
-              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.1-src.zip.asc">pgp</a></td>
+              <td><a href="[preferred]/commons/commons-release-plugin/source/commons-release-plugin-1.3-src.zip">commons-release-plugin-1.3-src.zip</a></td>
+              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.3-src.zip.sha256">sha256</a></td>
+              <td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.3-src.zip.asc">pgp</a></td>
           </tr>
         </table>
       </subsection>

diff --git a/src/site/xdoc/release-history.xml b/src/site/xdoc/release-history.xml
@@ -24,6 +24,9 @@ limitations under the License.
 
             <table>
                 <tr><th>Version</th><th>Release date</th><th>Required Java Version</th><th>Javadoc</th><th>Release notes</th></tr>
+                <tr>
+                    <td>1.3</td><td>6-15-2018</td><td>8.0</td><td><a href="javadocs/api-1.3/index.html">api-1.3</a></td><td><a href="release-notes/RELEASE-NOTES-1.3.txt">release notes for 1.3</a></td>
+                </tr>
                 <tr>
                     <td>1.2</td><td>4-2-2018</td><td>7.0</td><td><a href="javadocs/api-1.2/index.html">api-1.2</a></td><td><a href="release-notes/RELEASE-NOTES-1.2.txt">release notes for 1.2</a></td>
                 </tr>