You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ace.apache.org by bu...@apache.org on 2012/08/20 17:23:05 UTC
svn commit: r829478 - in /websites/staging/ace/trunk/content: ./
dev-doc/release-guide.html
Author: buildbot
Date: Mon Aug 20 15:23:05 2012
New Revision: 829478
Log:
Staging update by buildbot for ace
Modified:
websites/staging/ace/trunk/content/ (props changed)
websites/staging/ace/trunk/content/dev-doc/release-guide.html
Propchange: websites/staging/ace/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Aug 20 15:23:05 2012
@@ -1 +1 @@
-1375053
+1375054
Modified: websites/staging/ace/trunk/content/dev-doc/release-guide.html
==============================================================================
--- websites/staging/ace/trunk/content/dev-doc/release-guide.html (original)
+++ websites/staging/ace/trunk/content/dev-doc/release-guide.html Mon Aug 20 15:23:05 2012
@@ -169,7 +169,102 @@
<p><a href="/"><i class='icon-home'></i> Home</a> » <a href="/dev-doc/">Dev-doc</a></p>
<h1>Release Guide</h1>
<div class="clear"></div>
- <div id="content"><p>Apache ACE is an open source project, and as such its only official releases are source releases. For convenience we also provide binaries. This document describes how to do a source release.</p></div>
+ <div id="content"><p>Apache ACE is an open source project, and as such its only official releases are source releases. For convenience we also provide binaries. This document describes how to do a source release. It is based on the <a href="http://www.apache.org/dev/release.html">Release FAQ</a>.</p>
+<h2 id="prerequisites">Prerequisites</h2>
+<p>To create a release you must:</p>
+<ul>
+<li>Be a committer in the Apache ACE project.</li>
+<li>Have ant installed on your system.</li>
+<li>Have svn installed on your system.</li>
+<li>Have gpg installed on your system.</li>
+<li>Have a public key added to: http://www.apache.org/dist/ace/KEYS</li>
+</ul>
+<p>Before you can start staging a release candidate, you must:</p>
+<ul>
+<li>Make sure there are no snapshot dependencies anymore.</li>
+<li>Create a tagged version of the sources in preparation of the release candidate.</li>
+</ul>
+<h2 id="staging-a-release-candidate">Staging a release candidate</h2>
+<p>Staging a release starts by checking out a tagged version of the sources:</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">svn</span> <span class="n">co</span> <span class="n">https:</span><span class="sr">//s</span><span class="n">vn</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="sr">/repos/</span><span class="n">asf</span><span class="sr">/ace/</span><span class="n">tags</span><span class="o">/</span><span class="n">ace</span><span class="o">-</span><span class="n">sources</span><span class="o">-</span><span class="mf">1.0.0</span> <span class="n">ace</span><span class="o">-</span><span class="n">sources</span><span class="o">-</span><span class="mf">1.0.0</span>
+</pre></div>
+
+
+<p>The next step is to create the source archive:</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">cd</span> <span class="n">build</span>
+<span class="nv">$</span> <span class="nv">ant</span> <span class="o">-</span><span class="n">f</span> <span class="n">src</span><span class="o">-</span><span class="n">build</span><span class="o">.</span><span class="n">xml</span> <span class="nb">package</span><span class="o">-</span><span class="n">src</span>
+</pre></div>
+
+
+<p>Then you sign the source archive, and create md5 and sha1 signatures for it:</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">ant</span> <span class="o">-</span><span class="n">f</span> <span class="n">src</span><span class="o">-</span><span class="n">build</span><span class="o">.</span><span class="n">xml</span> <span class="n">sign</span><span class="o">-</span><span class="n">src</span>
+</pre></div>
+
+
+<p>Now you can upload the source archive and the signatures to our development area, which we use to stage this release candidate. This can be done via "svnpubsub":</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">ant</span> <span class="o">-</span><span class="n">f</span> <span class="n">src</span><span class="o">-</span><span class="n">build</span><span class="o">.</span><span class="n">xml</span> <span class="n">commit</span><span class="o">-</span><span class="n">to</span><span class="o">-</span><span class="n">staging</span>
+</pre></div>
+
+
+<h2 id="voting-on-the-release">Voting on the release</h2>
+<p>Start a vote on the dev@ace.apache.org list:</p>
+<div class="codehilite"><pre><span class="n">To:</span> <span class="s">"Apache ACE developers list"</span> <span class="sr"><dev@ace.apache.org></span>
+<span class="n">Subject:</span> <span class="p">[</span><span class="n">VOTE</span><span class="p">]</span> <span class="n">Release</span> <span class="n">ACE</span> <span class="n">version</span> <span class="n">X</span><span class="o">.</span><span class="n">Y</span><span class="o">.</span><span class="n">Z</span>
+
+<span class="n">Please</span> <span class="n">vote</span> <span class="n">to</span> <span class="n">approve</span> <span class="n">this</span> <span class="n">release:</span>
+<span class="p">[</span> <span class="p">]</span> <span class="o">+</span><span class="mi">1</span> <span class="n">Approve</span> <span class="n">the</span> <span class="n">release</span>
+<span class="p">[</span> <span class="p">]</span> <span class="o">-</span><span class="mi">1</span> <span class="n">Veto</span> <span class="n">the</span> <span class="n">release</span> <span class="p">(</span><span class="n">please</span> <span class="n">motivate</span><span class="p">)</span>
+
+<span class="n">This</span> <span class="n">vote</span> <span class="n">will</span> <span class="n">be</span> <span class="nb">open</span> <span class="k">for</span> <span class="n">at</span> <span class="n">least</span> <span class="mi">72</span> <span class="n">hours</span><span class="o">.</span>
+</pre></div>
+
+
+<p>The formal requirements on approving a release are:</p>
+<blockquote>
+<p>Votes on whether a package is ready to be released use majority approval -- i.e. at least three PMC members must vote affirmatively for release, and there must be more positive than negative votes. Releases may not be vetoed. Before voting +1 PMC members are required to download the signed source code package, compile it as provided, and test the resulting executable on their own platform, along with also verifying that the package contains the required contents.</p>
+</blockquote>
+<p>The list of PMC (and project) members can be found here: http://ace.apache.org/get-involved/project-team.html</p>
+<p>Wrap up the vote with an e-mail to the dev@ace.apache.org list again:</p>
+<div class="codehilite"><pre><span class="n">To:</span> <span class="s">"Apache ACE developers list"</span> <span class="sr"><dev@ace.apache.org></span>
+<span class="n">Subject:</span> <span class="p">[</span><span class="n">RESULT</span><span class="p">]</span> <span class="p">[</span><span class="n">VOTE</span><span class="p">]</span> <span class="n">Release</span> <span class="n">ACE</span> <span class="n">version</span> <span class="n">X</span><span class="o">.</span><span class="n">Y</span><span class="o">.</span><span class="n">Z</span>
+
+<span class="n">The</span> <span class="n">vote</span> <span class="n">has</span> <span class="n">passed</span><span class="o">/</span><span class="n">failed</span> <span class="n">with</span> <span class="n">the</span> <span class="n">following</span> <span class="n">result:</span>
+<span class="o">+</span><span class="mi">1</span> <span class="p">(</span><span class="n">binding</span><span class="p">):</span> <span class="o">...</span>
+<span class="o">+</span><span class="mi">1</span> <span class="p">(</span><span class="n">non</span><span class="o">-</span><span class="n">binding</span><span class="p">):</span> <span class="o">...</span>
+<span class="o">-</span><span class="mi">1</span><span class="p">:</span> <span class="o">...</span>
+</pre></div>
+
+
+<p>And, depending on the result, continue with either promoting or cancelling the release below.</p>
+<h2 id="promoting-the-release">Promoting the release</h2>
+<p>Move the artifacts from the development area to the final release location:</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">ant</span> <span class="o">-</span><span class="n">f</span> <span class="n">src</span><span class="o">-</span><span class="n">build</span><span class="o">.</span><span class="n">xml</span> <span class="n">promote</span><span class="o">-</span><span class="n">to</span><span class="o">-</span><span class="n">release</span>
+</pre></div>
+
+
+<p>Then update the tag in subversion, for example for the 1.0.0 release like this:</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">svn</span> <span class="n">move</span> <span class="n">https:</span><span class="sr">//s</span><span class="n">vn</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="sr">/repos/</span><span class="n">asf</span><span class="sr">/ace/</span><span class="n">tags</span><span class="sr">/ace-sources-1.0.0 https://svn.apache.org/</span><span class="n">repos</span><span class="sr">/asf/</span><span class="n">ace</span><span class="sr">/releases/</span><span class="n">ace</span><span class="o">-</span><span class="n">sources</span><span class="o">-</span><span class="mf">1.0.0</span> <span class="o">-</span><span class="n">m</span> <span class="s">"Apache ACE source release 1.0.0 tagged."</span>
+</pre></div>
+
+
+<p>Now wait at least 24 hours to allow the release to be properly mirrored and then update the news and download page on the Apache ACE website and announce the release:</p>
+<div class="codehilite"><pre><span class="n">To:</span> <span class="s">"Apache ACE users list"</span> <span class="sr"><users@ace.apache.org></span>
+<span class="n">Subject:</span> <span class="p">[</span><span class="n">ANN</span><span class="p">]</span> <span class="n">ACE</span> <span class="n">version</span> <span class="n">X</span><span class="o">.</span><span class="n">Y</span><span class="o">.</span><span class="n">Z</span> <span class="n">released</span><span class="o">.</span>
+
+<span class="n">The</span> <span class="n">Apache</span> <span class="n">ACE</span> <span class="n">team</span> <span class="n">is</span> <span class="n">proud</span> <span class="n">to</span> <span class="n">announce</span> <span class="n">the</span> <span class="n">release</span> <span class="n">of</span> <span class="n">ACE</span> <span class="n">version</span> <span class="n">X</span><span class="o">.</span><span class="n">Y</span><span class="o">.</span><span class="n">Z</span><span class="o">.</span>
+
+<span class="n">This</span> <span class="n">release</span> <span class="n">is</span> <span class="n">available</span> <span class="n">from</span> <span class="k">our</span> <span class="n">download</span> <span class="n">page</span> <span class="n">at:</span>
+<span class="n">http:</span><span class="sr">//</span><span class="n">ace</span><span class="o">.</span><span class="n">apache</span><span class="o">.</span><span class="n">org</span><span class="o">/</span><span class="n">downloads</span><span class="o">.</span><span class="n">html</span>
+</pre></div>
+
+
+<h2 id="cancelling-the-release">Cancelling the release</h2>
+<p>Remove the artifacts from the development area:</p>
+<div class="codehilite"><pre><span class="nv">$</span> <span class="nv">ant</span> <span class="o">-</span><span class="n">f</span> <span class="n">src</span><span class="o">-</span><span class="n">build</span><span class="o">.</span><span class="n">xml</span> <span class="nb">delete</span><span class="o">-</span><span class="n">from</span><span class="o">-</span><span class="n">staging</span>
+</pre></div>
+
+
+<p>We keep the tag in subversion for reference.</p></div>
<hr>
<footer>
<p>Copyright © 2012 <a href="http://www.apache.org/">The Apache Software Foundation</a>, Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.<br/>Apache ACE, the Apache ACE logo, Apache and the Apache feather logo are trademarks of The Apache Software Foundation. All other marks mentioned may be trademarks or registered trademarks of their respective owners.</p>