Skip to content
Permalink
Browse files
  • Loading branch information
chtompki committed Mar 5, 2018
2 parents 8af3b4c + d71325b commit d209f1ea36445536acda6b27e5ebc534ab6c2dcc
Show file tree
Hide file tree
Showing 11 changed files with 117 additions and 26 deletions.
@@ -66,7 +66,7 @@ Alternatively you can pull it from the central Maven repositories:
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-release-plugin</artifactId>
<version>1.0</version>
<version>1.1</version>
</dependency>
```

@@ -1,5 +1,5 @@
Apache Commons Release Plugin
Version 1.0
Version 1.1
Release Notes

INTRODUCTION
@@ -18,6 +18,26 @@ Changes in this version include:
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.
@@ -373,7 +373,7 @@
<artifactId>commons-release-plugin</artifactId>
<version>1.0</version>
<configuration>
<distSvnStagingUrl>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</distSvnStagingUrl>
<distSvnStagingUrl>scm:svn:https://dist.apache.org/repos/dist/dev/commons/commons-release-plugin</distSvnStagingUrl>
<dryRun>${dryRun}</dryRun>
</configuration>
<executions>
@@ -657,4 +657,4 @@
</properties>
</profile>
</profiles>
</project>
</project>
@@ -24,8 +24,10 @@
<fileSets>
<fileSet>
<includes>
<include>CONTRIBUTING.md</include>
<include>LICENSE.txt</include>
<include>NOTICE.txt</include>
<include>README.md</include>
<include>RELEASE-NOTES.txt</include>
</includes>
</fileSet>
@@ -24,12 +24,16 @@
<fileSets>
<fileSet>
<includes>
<include>checkstyle.xml</include>
<include>checkstyle-suppressions.xml</include>
<include>CONTRIBUTING.md</include>
<include>fb-excludes.xml</include>
<include>LICENSE</include>
<include>LICENSE.txt</include>
<include>NOTICE.txt</include>
<include>pom.xml</include>
<include>RELEASE-NOTES.txt</include>
<include>README.md</include>
<include>README.md</include>
<include>RELEASE-NOTES.txt</include>
</includes>
</fileSet>
<fileSet>
@@ -25,7 +25,10 @@
</properties>

<body>
<release version="1.1" date="YYYY-MM-DD" description="tbd">
<release version="1.2" date="YYYY-MM-DD" description="tbd">
</release>

<release version="1.1" date="2018-02-28" description="1.1">
<action issue="COMMONSSITE-104" type="fix" dev="chtompki">Sha1 signature files now reflect actual signatures.</action>
<action issue="COMMONSSITE-98" type="add" dev="chtompki">Making the project more multi-module compatible</action>
<action issue="COMMONSSITE-102" type="fix" dev="chtompki">Commons Release Plugin doesn't work with Commons Release Plugin</action>
@@ -0,0 +1,56 @@
Apache Commons Release Plugin
Version 1.1
Release Notes

INTRODUCTION
============
This document contains the release notes for the 1.0 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-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

@@ -57,19 +57,22 @@ public class CommonsDistributionDetachmentMojo extends AbstractMojo {
imported to the Mojo by the existent maven variables or the declared <code>&lt;configuration&gt;</code>. For
example, we have a boolean variable named <code>dryRun</code> declared as:
<source><![CDATA[
@Parameter
@Parameter(property = "commons.release.dryRun", defaultValue = "false")
private Boolean dryRun;
]]></source>
that can be configured by
<source><![CDATA[
<plugin>
<groupId>org.apache.commons</groupId>
<artifactId>commons-release-plugin</artifactId>
<version>1.0</version>
<version>1.1</version>
<configuration>
<dryRun>true</dryRun>
</configuration>
</plugin>]]></source>

And, because we've set the <code>property here</code> (as in the 1.1 release), you can, on the command line,
use the following <code>-Dcommons.release.dryRun=true</code>.
</p>

</section>
@@ -111,32 +111,32 @@ limitations under the License.
</p>
</subsection>
</section>
<section name="Apache Commons Release Plugin 1.0 ">
<section name="Apache Commons Release Plugin 1.1 ">
<subsection name="Binaries">
<table>
<tr>
<td><a href="[preferred]/commons/commons-release-plugin/binaries/commons-release-plugin-1.0-bin.tar.gz">commons-release-plugin-1.0-bin.tar.gz</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.0-bin.tar.gz.md5">md5</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.0-bin.tar.gz.asc">pgp</a></td>
<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.md5">md5</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>
</tr>
<tr>
<td><a href="[preferred]/commons/commons-release-plugin/binaries/commons-release-plugin-1.0-bin.zip">commons-release-plugin-1.0-bin.zip</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.0-bin.zip.md5">md5</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-release-plugin/binaries/commons-release-plugin-1.0-bin.zip.asc">pgp</a></td>
<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.md5">md5</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>
</tr>
</table>
</subsection>
<subsection name="Source">
<table>
<tr>
<td><a href="[preferred]/commons/commons-release-plugin/source/commons-release-plugin-1.0-src.tar.gz">commons-release-plugin-1.0-src.tar.gz</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.0-src.tar.gz.md5">md5</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.0-src.tar.gz.asc">pgp</a></td>
<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.md5">md5</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>
</tr>
<tr>
<td><a href="[preferred]/commons/commons-release-plugin/source/commons-release-plugin-1.0-src.zip">commons-release-plugin-1.0-src.zip</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.0-src.zip.md5">md5</a></td>
<td><a href="https://www.apache.org/dist/commons/commons-release-plugin/source/commons-release-plugin-1.0-src.zip.asc">pgp</a></td>
<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.md5">md5</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>
</tr>
</table>
</subsection>
@@ -79,10 +79,10 @@
<plugin>
<groupId>org.apache.commons</groupId>
<artifactId>commons-release-plugin</artifactId>
<version>1.0</version>
<version>1.1</version>
<configuration>
<distSvnStagingUrl>scm:svn:https://dist.apache.org/repos/dist/dev/commons/foo</distSvnStagingUrl>
<dryRun>${dryRun}</dryRun>
<isDistModule>true</isDistModule>
</configuration>
<executions>
<execution>
@@ -126,14 +126,14 @@
<li>
running the following command:
<source><![CDATA[
mvn -Duser.name=<yourApacheId> [-Duser.password=<yourApacheIdsPassword] [-DdryRun=true -Ptest-deploy] -Prelease clean test site deploy
mvn -Duser.name=<yourApacheId> [-Duser.password=<yourApacheIdsPassword] [-Dcommons.release.dryRun=true -Ptest-deploy] -Prelease clean test site deploy
]]></source>
</li>
</ol>
If the component is new, then, before running this maven command, you would want to create
the requisite subversion directory <code>https://dist.apache.org/repos/dist/dev/commons/foo</code>. Notice,
that the way to perform a dry run of the release you need to include
<code>-DdryRun=true -Ptest-deploy</code>.
<code>-Dcommons.release.dryRun=true -Ptest-deploy</code>.
</p>
</section>

@@ -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.1</td><td>2-28-2018</td><td>7.0</td><td><a href="javadocs/api-1.1/">api-1.1</a></td><td><a href="release-notes/RELEASE-NOTES-1.1.txt">release notes for 1.1</a></td>
</tr>
<tr>
<td>1.0</td><td>1-10-2018</td><td>7.0</td><td><a href="javadocs/api-1.0/">api-1.0</a></td><td><a href="release-notes/RELEASE-NOTES-1.0.txt">release notes for 1.0</a></td>
</tr>

0 comments on commit d209f1e

Please sign in to comment.