Author: aheritier
Date: Sat May 12 13:54:04 2007
New Revision: 537513
URL: http://svn.apache.org/viewvc?view=rev&rev=537513
Log:
Update the doc to release the distribution
Modified:
maven/maven-1/core/trunk/xdocs/developers/making-releases.xml
Modified: maven/maven-1/core/trunk/xdocs/developers/making-releases.xml
URL:
http://svn.apache.org/viewvc/maven/maven-1/core/trunk/xdocs/developers/making-releases.xml?view=diff&rev=537513&r1=537512&r2=537513
==============================================================================
--- maven/maven-1/core/trunk/xdocs/developers/making-releases.xml (original)
+++ maven/maven-1/core/trunk/xdocs/developers/making-releases.xml Sat May 12
13:54:04 2007
@@ -29,15 +29,16 @@
<section name="Prerequesites">
<p>You have do these steps only for your first release.</p>
<subsection name="Setup your maven settings">
- <p>You must define the following properties in
<code>~/build.properties</code>. (Note: you may want to put these in
<code>maven-plugins/plugin-parent/build.properties</code> instead if you need
to define them differently for other projects).</p>
+ <p>You must define the following properties in
<code>~/build.properties</code>. (Note: you may want to put these in
<code>maven-plugins/plugin-parent/build.properties</code> and in
<code>core/build.properties</code> instead if you need to define them
differently for other projects).</p>
<ul>
<li><code>maven.username</code> - your apache username to deploy the
web site.</li>
<li><code>maven.password</code> - your apache password (if needed,
depending of the protocol used in the site plugin).</li>
<li><code>maven.repo.apache.releases.username</code> - your apache
username</li>
<li><code>maven.repo.apache.releases.privatekey</code> - the
filename of your SSH private key</li>
<li><code>maven.repo.apache.releases.passphrase</code> - the
passphrase for your private key (<b>not</b> your Apache password)</li>
- <li><code>maven.announcement.mail.from</code> - Your name and email
address, as subscribed to the users and developers mailing lists, e.g.
<code>Brett Porter <[EMAIL PROTECTED]></code></li>
+ <li><code>maven.announcement.mail.from</code> - Your name and email
address, as subscribed to the users and developers mailing lists, e.g.
<code>Brett Porter <[EMAIL PROTECTED]></code>. It's needed to use your
apache account if you want to send the announcement to [EMAIL PROTECTED]</li>
<li><code>maven.announcement.mail.server</code> - The SMTP server to
use for sending the announcement mail.</li>
+ <li><code>maven.nsis.exe</code> - The path to the nsis binary to
generate the setup for the maven distribution.</li>
</ul>
</subsection>
<subsection name="Generate a code signing key (OpenPGP Compatible
Signature)">
@@ -71,14 +72,14 @@
</ol>
</subsection>
</section>
- <section name="Releasing Maven or a Plugin">
+ <section name="Releasing a Plugin or a Component">
<p>For more general notes on making a release, please see the <a
href="../using/releasing.html">Releasing</a> documentation in the User's
Guide.</p>
<ul>
<li>
<p>Run <code>maven scm:prepare-release</code> and enter the
appropriate tag (<code>maven-[projectname]-[major].[minor].[bugfix]</code>) and
version.</p>
</li>
<li>
- <p>Produce a clean build using <code>maven
-Dmaven.repo.list=apache.releases -Dmaven.site.deploy.live=true
scm:perform-release</code>. When prompted for the tag, enter the one used in
the previous step. When prompted for the goal, enter
<code>plugin:repository-deploy,source:deploy,javadoc:deploy,site:deploy</code>
for plugins, or
<code>jar:deploy,source:deploy,javadoc:deploy,site:deploy</code> for an
individual JAR. To release a Maven distribution, see below.</p>
+ <p>Produce a clean build using <code>maven
-Dmaven.repo.list=apache.releases -Dmaven.site.deploy.live=true
scm:perform-release</code>. When prompted for the tag, enter the one used in
the previous step. When prompted for the goal, enter
<code>plugin:repository-deploy,source:deploy,javadoc:deploy,site:deploy</code>
for plugins, or
<code>jar:deploy,source:deploy,javadoc:deploy,site:deploy</code> for an
individual JAR.</p>
</li>
<li>
<p>Check for the new version at <a
href="http://people.apache.org/repo/m1-ibiblio-rsync-repository/maven/plugins/";>http://people.apache.org/repo/m1-ibiblio-rsync-repository/maven/plugins/</a>
or <a
href="http://people.apache.org/repo/m1-ibiblio-rsync-repository/maven/jars/";>http://people.apache.org/repo/m1-ibiblio-rsync-repository/maven/jars/</a>.</p>
@@ -92,7 +93,8 @@
</ul>
</section>
<section name="Releasing a Maven Distribution">
- <p>There are a couple of additional steps when releasing a Maven
distribution.</p>
+ <p>For more general notes on making a release, please see the <a
href="../using/releasing.html">Releasing</a> documentation in the User's
Guide.</p>
+ <p>Compared to a plugin or a component, there are a couple of additional
steps when releasing a Maven distribution.</p>
<ul>
<li>
<p>Run <code>maven maven:build-plugin-profile</code> and check the
versions are what you expect to distribute</p>
@@ -101,10 +103,32 @@
<p>Update the website files for the download links and release
notes</p>
</li>
<li>
- <p>Run <code>scm:perform-release</code> with the goals
<code>clean,jar:deploy,source:deploy,javadoc:deploy,maven:installer</code>. Do
this on Windows so that the .exe file is generated</p>
+ <p>Run <code>maven scm:prepare-release</code> and enter the
appropriate tag (<code>maven-[major].[minor].[bugfix]</code>) and version.</p>
+ </li>
+ <li>
+ <p>Produce a clean build using <code>maven
-Dmaven.repo.list=apache.releases -Dmaven.site.deploy.live=true
scm:perform-release</code>. When prompted for the tag, enter the one used in
the previous step. When prompted for the goal, enter
<code>clean,jar:deploy,source:deploy,javadoc:deploy,maven:installer</code>. Do
this on Windows so that the .exe file is generated (you have to install NSIS,
and to setup the NSIS plugin to find the exe). You can find the binaries in
<code>target/checkout/target/installer</code></p>
+ </li>
+ <li>
+ <p>Sign and create checksums for the binaries :</p>
+ <source><![CDATA[
+gpg --local-user "[FirstName] [LastName] (CODE SIGNING KEY) <[YourEMail] @
apache.org>" --armor --detach-sign maven-[version].exe
+gpg --print-md MD5 maven-[version].exe > maven-[version].exe.md5
+gpg --local-user "[FirstName] [LastName] (CODE SIGNING KEY) <[YourEMail] @
apache.org>" --armor --detach-sign maven-[version].tar.bz2
+gpg --print-md MD5 maven-[version].tar.bz2 > maven-[version].tar.bz2.md5
+gpg --local-user "[FirstName] [LastName] (CODE SIGNING KEY) <[YourEMail] @
apache.org>" --armor --detach-sign maven-[version].tar.gz
+gpg --print-md MD5 maven-[version].tar.gz > maven-[version].tar.gz.md5
+gpg --local-user "[FirstName] [LastName] (CODE SIGNING KEY) <[YourEMail] @
apache.org>" --armor --detach-sign maven-[version].zip
+gpg --print-md MD5 maven-[version].zip > maven-[version].zip.md5
+]]></source>
+ </li>
+ <li>
+ <p>Manually upload the distributions on
<code>people.apache.org</code> to the distribution location (under
<code>/www/www.apache.org/dist/maven/binaries/</code>).</p>
+ </li>
+ <li>
+ <p>Check for the new version at <a
href="http://www.apache.org/dist/maven/binaries/";>http://www.apache.org/dist/maven/binaries/</a>.</p>
</li>
<li>
- <p>Manually upload the distributions to the distribution location
(under <code>/binaries/</code>) and sign them.</p>
+ <p>Go to the <a
href="http://jira.codehaus.org/secure/project/ManageVersions.jspa?pid=10030";>JIRA
administration page</a> for the Maven project (Note that you need to be a JIRA
administrator for this project) and <strong>release</strong> the version. Also
make sure to <strong>add</strong> a new version for the following development
version. This is required so that developers can assign a "fix for" version to
issues.</p>
</li>
<li>
<p>Run <code>scm:perform-release</code> with the
<code>site:deploy</code> goal, and mail out release notes</p>
