Author: chtompki Date: Mon Oct 29 12:18:41 2018 New Revision: 1845112 URL: http://svn.apache.org/viewvc?rev=1845112&view=rev Log: More docs on commons-release-plugin
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=1845112&r1=1845111&r2=1845112&view=diff ============================================================================== --- commons/cms-site/trunk/content/xdoc/releases/prepare.xml (original) +++ commons/cms-site/trunk/content/xdoc/releases/prepare.xml Mon Oct 29 12:18:41 2018 @@ -201,7 +201,7 @@ mvn versions:display-plugin-updates -U</ problems. </p> </subsection> - <subsection name='Configure the Build to Generate a Complete Set of Release Artifacts'> + <subsection name='Configure the Build and Release Plugin to Generate a Complete Set of Release Artifacts'> <p> For builds using Maven, the contents of the source and binary distributions are configured in assembly descriptors. By convention, these are stored in src/main/assembly and named @@ -225,8 +225,8 @@ mvn versions:display-plugin-updates -U</ <!-- properties not related to versioning --> <commons.jira.id>FOO</commons.jira.id> <commons.jira.pid>007</commons.jira.pid> - <maven.compile.source>1.3</maven.compile.source> - <maven.compile.target>1.3</maven.compile.target> + <maven.compile.source>1.8</maven.compile.source> + <maven.compile.target>1.8</maven.compile.target> <!-- Encoding of Java source files: ensures that the compiler and @@ -240,6 +240,13 @@ mvn versions:display-plugin-updates -U</ <project.build.sourceEncoding>${commons.encoding}</project.build.sourceEncoding> <!-- This is used by reporting plugins --> <project.reporting.outputEncoding>${commons.encoding}</project.reporting.outputEncoding> + <!-- Commons Release Plugin --> + <commons.bc.version>1.5</commons.bc.version> + <commons.release-plugin.version>1.4</commons.release-plugin.version> + <commons.release.isDistModule>true</commons.release.isDistModule> + <commons.distSvnStagingUrl>scm:svn:https://dist.apache.org/repos/dist/dev/commons/${commons.componentid}</commons.distSvnStagingUrl> + <commons.releaseManagerName>***Release Manager Name***</commons.releaseManagerName> + <commons.releaseManagerKey>***Release Manager GPG Key Signature***</commons.releaseManagerKey> <properties> </pre> </p> @@ -646,6 +653,12 @@ mvn versions:display-plugin-updates -U</ 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. + + Further, the commons-release-plugin, as of 1.4, can automatically generate the vote email for you. When you've + finished staging the artifacts, run + <pre><![CDATA[mvn -Prelease org.apache.commons:commons-release-plugin:1.4:vote-txt]]></pre> + This will generate a file <code>target/vote.txt</code> that will need to be altered for the vote email, but it + gives you a considerable head start on writing the email. </subsection> <subsection name="Create the Release Candidate Manually"> @@ -744,6 +757,12 @@ mvn versions:display-plugin-updates -U</ </section> <section name='Voting On Release'> + + <subsection name="Using commons-release-plugin"> + The vote email should have been mostly generated for you by the plugin. See the section above pertaining + to the commons-release-plugin for more details. + </subsection> + <subsection name='[VOTE] Release Foo 1.2 based on RC1'> <p> Once the release candidate has been created and uploaded, now it's time to propose the release VOTE.