Author: buildbot
Date: Tue Dec 10 08:16:30 2013
New Revision: 889814
Log:
Staging update by buildbot for celix
Modified:
websites/staging/celix/trunk/content/ (props changed)
websites/staging/celix/trunk/content/celix/documentation/releasing.html
Propchange: websites/staging/celix/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Tue Dec 10 08:16:30 2013
@@ -1 +1 @@
-1549769
+1549781
Modified:
websites/staging/celix/trunk/content/celix/documentation/releasing.html
==============================================================================
--- websites/staging/celix/trunk/content/celix/documentation/releasing.html
(original)
+++ websites/staging/celix/trunk/content/celix/documentation/releasing.html Tue
Dec 10 08:16:30 2013
@@ -133,42 +133,55 @@
<div id="homeleft">
<h1 class="title">Releasing Apache Celix</h1>
<p>Note: This information is only of use to Apache
Celix Release Managers!</p>
-<p>Loosely based on:
https://cwiki.apache.org/confluence/display/WHIRR/How+To+Release</p>
<p>Steps to follow:</p>
<ul>
-<li>Be sure to have a key on file</li>
-<li>Update/Create CHANGES file</li>
-<li>Generate Release Notes (Combine with Changes?)</li>
-<li>Run complete build, including tests and coverage targets. Make sure the
provided examples work</li>
-<li>Run Apache RAT target</li>
-<li>Create TAG</li>
-<li>Create and sign artefacts</li>
-<li>Copy artefact and signatures to dev repo</li>
-<li>Run the Vote</li>
-<li>Tally the vote results</li>
-<li>Stage release for mirroring by copying to release repo</li>
-<li>Announce release (wait for mirror syncing) </li>
+<li>Create signing KEYs</li>
+<li>Update release related files</li>
+<li>Compile and test</li>
+<li>Create SVN tag</li>
+<li>Create, sign and publish artefacts</li>
+<li>Run the vote</li>
+<li>Post the vote results</li>
+<li>Roll out the release artefacts</li>
+<li>Announce the release</li>
+</ul>
+<p>Interesting links:</p>
+<ul>
+<li><a href="http://www.apache.org/dev/release.html";>Apache Release
Guide</a></li>
+<li><a
href="http://incubator.apache.org/guides/releasemanagement.html";>Incubator
Release Management Guide</a></li>
+<li><a href="http://www.apache.org/dev/release-signing.html";>Apache Release
Signing</a></li>
+<li><a href="http://creadur.apache.org/rat/apache-rat/index.html";>Apache
RAT</a></li>
+<li><a href="http://www.apache.org/dev/openpgp.html";>Apache OpenPGP
Howto</a></li>
+<li><a href="http://people.apache.org/~brane/incubator/votes.html";>Voting
Status</a></li>
+<li><a href="http://wiki.apache.org/incubator/ReleaseChecklist";>Incubator
Release Checklist</a> (In Progress, do we need it?)</li>
</ul>
-<h2 id="code-signing-keys">Code Signing keys</h2>
+<h2 id="create-signing-keys">Create signing KEYs</h2>
<p>Each Release Manager must have his own signing keys. Information about and
instruction for the generation of these keys can be found on the
-<a href="http://www.apache.org/dev/release-signing.html#generate";>Signing
Releases page</a>. Be sure to follow the information provided on that site and
its references.</p>
+<a href="http://www.apache.org/dev/release-signing.html#generate";>Signing
Releases page</a> and <a
href="http://www.apache.org/dev/openpgp.html#generate-key";>How To OpenPGP</a>.
Be sure to follow the information provided on that site and its references.</p>
+<p>The generated key can be uploaded to the <a href="http://pgp.mit.edu";>MIT
PGP Public Key Server</a>.</p>
<p>Next, the public key signature must be added to the KEYS file. Again, read
the <a
href="http://www.apache.org/dev/release-signing.html#keys-policy";>Signing
Releases page</a>
for more information. This updated file needs to be uploaded to SVN, be sure
to upload it to:</p>
<ul>
-<li>https://dist.apache.org/repos/dist/dev/incubator/celix/KEYS</li>
-<li>https://dist.apache.org/repos/dist/release/incubator/celix/KEYS</li>
+<li><a
href="https://dist.apache.org/repos/dist/dev/incubator/celix/KEYS";>Apache Celix
release development area KEYS</a></li>
+<li><a
href="https://dist.apache.org/repos/dist/release/incubator/celix/KEYS";>Apache
Celix release distribution area KEYS</a></li>
</ul>
-<h2 id="update-release-related-files">Update Release Related Files</h2>
+<h2 id="update-release-related-files">Update release related files</h2>
<p>For every release the related files must be updated. The following files
are relevant:</p>
<ul>
<li>
<p>CHANGES</p>
-<p>Add a list of fixed issues which can be created using Jira.
- - RELEASE_NOTES</p>
-<p>Add additional notes regarding this release, eg known short comings.
- - BUILDING</p>
-<p>Even though the BUILDING file doesn't have any specific release
information, it should be verified before making a release.<br />
- - NOTICE</p>
+<p>Add a list of fixed issues which can be created using Jira.</p>
+</li>
+<li>
+<p>RELEASE_NOTES</p>
+<p>Add additional notes regarding this release, eg known short comings.</p>
+</li>
+<li>
+<p>BUILDING</p>
+<p>Even though the BUILDING file doesn't have any specific release
information, it should be verified before making a release. </p>
+</li>
+<li>
+<p>NOTICE</p>
<p>If needed, add any new license related information to this file.</p>
</li>
</ul>
@@ -183,7 +196,7 @@ Update the following pieces:</p>
</ul>
<p>While Celix is in incubation, the qualifier should (at least) always
contain "incubating" as text.</p>
<p>Note: The DEFAULT_VERSION property is used as default version for new
bundles and as such does not need to be updated when making a release.</p>
-<h2 id="compile-and-test">Compile and Test</h2>
+<h2 id="compile-and-test">Compile and test</h2>
<p>Before creating a branch, be sure that the source compiles and tests run
successfully. If there are any known shortcomings, make sure they are listed in
the
RELEASE_NOTES. Details for compiling and testing are available in the BUILDING
file.</p>
<p>Also verify that the provides examples work as expected. If needed ask
other committers to test parts, eg the GTK examples.</p>
@@ -192,16 +205,36 @@ the check: make rat </p>
<p>Apache RAT should not raise any concers, if there are, check the source
files for
a license header. If it is a false positive update the rat-excludes.txt file
in the root of the project. Be sure it is a false positive! If in doubt, ask
the
mailing list! Third party licenses may need to be mentioned in the NOTICE
file.</p>
-<h2 id="tag-release">Tag release</h2>
+<h2 id="create-svn-tag">Create SVN tag</h2>
<p>After changing all files a tag for the new release must be made. Before
doing so, make sure all changed files are committed.</p>
<p>The tag should be named like this: celix-X.Y.Z.incubating</p>
<p>To make a tag use the following command:</p>
<p>svn copy http://svn.apache.org/repos/asf/incubator/celix/trunk/
http://svn.apache.org/repos/asf/incubator/celix/tags/celix-X.Y.Z.incubating -m
"X.Y.Z release of the Apache Celix project."</p>
<p>Note: Make sure there are no new changes made on trunk while working on the
release. Discuss: Use a branch for staging the release and the files? Or
possibly use a revision nr?</p>
-<h2 id="publish-source-archive-for-voting">Publish Source Archive for
Voting</h2>
-<p>Copy the archive of the source to
https://dist.apache.org/repos/dist/dev/incubator/celix/ (using SVN).</p>
-<p>See: http://www.apache.org/dev/release.html#host-rc</p>
-<h2 id="run-the-vote">Run the Vote</h2>
+<h2 id="create-sign-and-publish-artefacts">Create, sign and publish
artefacts</h2>
+<p>Since Celix only releases source artefacts, creating the artefact is simple
and straightforward</p>
+<div class="codehilite"><pre><span class="c1">// Create symbolic link so the
archive has a directory with version information</span>
+<span class="o">></span> <span class="n">ln</span> <span
class="o">-</span><span class="n">s</span> <span class="n">celix</span> <span
class="n">celix</span><span class="o">-</span><span class="no">X</span><span
class="p">.</span><span class="no">Y</span><span class="p">.</span><span
class="no">Z</span><span class="p">.</span><span class="n">incubating</span>
+<span class="c1">// Create GZip archive</span>
+<span class="o">></span> <span class="n">tar</span> <span
class="o">-</span><span class="n">hczf</span> <span class="n">celix</span><span
class="o">-</span><span class="no">X</span><span class="p">.</span><span
class="no">Y</span><span class="p">.</span><span class="no">Z</span><span
class="p">.</span><span class="n">incubating</span><span
class="p">.</span><span class="n">tar</span><span class="p">.</span><span
class="n">gz</span> <span class="n">celix</span><span class="o">-</span><span
class="no">X</span><span class="p">.</span><span class="no">Y</span><span
class="p">.</span><span class="no">Z</span><span class="p">.</span><span
class="n">incubating</span>
+<span class="c1">// The create symbolic link can be removed</span>
+<span class="o">></span> <span class="n">celix</span> <span
class="n">celix</span><span class="o">-</span><span class="no">X</span><span
class="p">.</span><span class="no">Y</span><span class="p">.</span><span
class="no">Z</span><span class="p">.</span><span class="n">incubating</span>
+</pre></div>
+
+
+<p>After creating the artefact, the file has to be signed. More information
about signing can be found at
(http://www.apache.org/dev/release-signing.html).</p>
+<div class="codehilite"><pre><span class="c1">// Generate MD5 checksum</span>
+<span class="o">></span> <span class="n">md5</span> <span
class="n">celix</span><span class="o">-</span><span class="no">X</span><span
class="p">.</span><span class="no">Y</span><span class="p">.</span><span
class="no">Z</span><span class="p">.</span><span
class="n">incubating</span><span class="p">.</span><span
class="n">tar</span><span class="p">.</span><span class="n">gz</span> <span
class="o">></span> <span class="n">celix</span><span class="o">-</span><span
class="no">X</span><span class="p">.</span><span class="no">Y</span><span
class="p">.</span><span class="no">Z</span><span class="p">.</span><span
class="n">incubating</span><span class="p">.</span><span
class="n">tar</span><span class="p">.</span><span class="n">gz</span><span
class="p">.</span><span class="n">md5</span>
+<span class="c1">// Generate SHA512 checksum</span>
+<span class="o">></span> <span class="n">gpg</span> <span
class="o">--</span><span class="n">print</span><span class="o">-</span><span
class="n">md</span> <span class="no">SHA512</span> <span
class="n">celix</span><span class="o">-</span><span class="no">X</span><span
class="p">.</span><span class="no">Y</span><span class="p">.</span><span
class="no">Z</span><span class="p">.</span><span
class="n">incubating</span><span class="p">.</span><span
class="n">tar</span><span class="p">.</span><span class="n">gz</span> <span
class="o">></span> <span class="n">celix</span><span class="o">-</span><span
class="no">X</span><span class="p">.</span><span class="no">Y</span><span
class="p">.</span><span class="no">Z</span><span class="p">.</span><span
class="n">incubating</span><span class="p">.</span><span
class="n">tar</span><span class="p">.</span><span class="n">gz</span><span
class="p">.</span><span class="n">sha</span>
+<span class="c1">// Generate ASCII signature</span>
+<span class="o">></span> <span class="n">gpg</span> <span
class="o">--</span><span class="n">armor</span> <span class="o">--</span><span
class="k">output</span> <span class="n">celix</span><span
class="o">-</span><span class="no">X</span><span class="p">.</span><span
class="no">Y</span><span class="p">.</span><span class="no">Z</span><span
class="p">.</span><span class="n">incubating</span><span
class="p">.</span><span class="n">tar</span><span class="p">.</span><span
class="n">gz</span><span class="p">.</span><span class="n">asc</span> <span
class="o">--</span><span class="n">detach</span><span class="o">-</span><span
class="n">sig</span> <span class="n">celix</span><span class="o">-</span><span
class="no">X</span><span class="p">.</span><span class="no">Y</span><span
class="p">.</span><span class="no">Z</span><span class="p">.</span><span
class="n">incubating</span><span class="p">.</span><span
class="n">tar</span><span class="p">.</span><span class="n">gz</span>
+</pre></div>
+
+
+<p>Copy the archive of the source to the <a
href="https://dist.apache.org/repos/dist/dev/incubator/celix/KEYS";>Apache Celix
release development area</a> (using SVN).</p>
+<p>See the <a href="http://www.apache.org/dev/release.html#host-rc";>Apache
Release Guide</a> for more information.</p>
+<h2 id="run-the-vote">Run the vote</h2>
<p>Before a release is official a vote has to be held. More information on
voting can be found on <a
href="http://www.apache.org/foundation/voting.html";>Apache Voting Process</a>.
Since Apache Celix is still in incubation, both the PPMC and the IPMC have to
vote for it.</p>
<p>The first vote has to be done on the public mailinglist of the project
itself ([email protected]). The following template must be used
for this vote:</p>
@@ -210,7 +243,7 @@ To: [email protected]
Subject: [VOTE] Release Celix version X.Y.Z</p>
<p>This is the release vote for Apache Celix, version X.Y.Z.</p>
<p>It fixes the following issues:
-{Create Release Note link using
(https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12323511)}</p>
+{Create Release Note link using <a
href="https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12323511";>Apache
Celix Jira</a>}</p>
<p>Source files:
https://dist.apache.org/repos/dist/dev/incubator/celix/celix-X.Y.Z-incubating/</p>
<p>The tag to be voted upon:
@@ -225,7 +258,7 @@ https://dist.apache.org/repos/dist/dev/i
<p>================================================================================================================</p>
<p>After this first vote the results must be posted to the "dev" list, see
below for more information.</p>
<p>The second vote has to go to the general incubator list, this is to give
the IPMC a chance to verify the release. This vote can only be published if the
PPMC
-has had enough time to review the release, following the defacto standard,
this is ate least 72 hours.</p>
+has had enough time to review the release, following the defacto standard,
this is at least 72 hours.</p>
<p>The template provided above can be reused for this, but needs to be
extended (directly after "This is the release vote for..." with the following
information:</p>
<p>================================================================================================================
This release has already been approved by:</p>
@@ -243,21 +276,20 @@ This release has already been approved b
</tr>
</tbody>
</table>
-<p>See {link to markmail archive of Celix release thread} for their votes.</p>
+<p>See {Create link to the archive of Celix release thread using <a
href="http://incubator.markmail.org/search/?q=list%3Aorg.apache.incubator.celix-dev";>Markmail</a>}
for their votes.</p>
<p>================================================================================================================</p>
-<p>Todo: Check usability of
http://wiki.apache.org/incubator/ReleaseChecklist</p>
<p>Note: Be sure to use the [VOTE] tag, this is used by the automated vote
tracking system to keep track of outstanding vote threads.</p>
-<h2 id="post-vote-results">Post Vote Results</h2>
+<h2 id="post-the-vote-results">Post the vote results</h2>
<p>As mentioned before, after each vote the results must be posted to the
corresponding list. This "Result" vote contains the number of votes made,
including
wether a vote is binding or not.</p>
<p>Note: Be sure to post the vote result as a reply to the original message.
Also prepend the subject with [RESULT]. This is, again, needed to be able to
keep track
-of vote threads. See http://people.apache.org/~brane/incubator/votes.html and
http://incubator.apache.org/facilities.html#voting-status</p>
-<h2 id="roll-out-release">Roll Out Release</h2>
+of vote threads. See <a
href="http://people.apache.org/~brane/incubator/votes.html";>Voting Status</a>
and <a href="http://incubator.apache.org/facilities.html#voting-status";>Voting
Status Howto</a></p>
+<h2 id="roll-out-release-artefacts">Roll out release artefacts</h2>
<p>If the vote is passed successfully the release can be moved from the "dev"
area to "release". The automated svnpubsub will move the artifact to the
correct
server for mirroring. Mirroring typically can take up to 24 hours.</p>
-<p>See: http://www.apache.org/dev/release.html#upload-ci</p>
+<p>See the <a href="http://www.apache.org/dev/release.html#upload-ci";>Apache
Release Guide</a> for more information.</p>
<p>After these 24 hours the release can be announced. </p>
-<h2 id="announce-release">Announce release</h2>
+<h2 id="announce-the-release">Announce the release</h2>
<p>Update website's "news section".</p>
<p>Post message to "[email protected]"?</p>
</div>
