You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@celix.apache.org by bu...@apache.org on 2013/12/10 07:47:16 UTC
svn commit: r889805 - in /websites/staging/celix/trunk/content: ./
celix/documentation/releasing.html
Author: buildbot
Date: Tue Dec 10 06:47:15 2013
New Revision: 889805
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 06:47:15 2013
@@ -1 +1 @@
-1549313
+1549769
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 06:47:15 2013
@@ -134,73 +134,83 @@
<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:
-<em> Be sure to have a key on file
-</em> Update/Create CHANGES file
-<em> Generate Release Notes (Combine with Changes?)
-</em> Run complete build, including tests and coverage targets. Make sure the provided examples work
-<em> Run Apache RAT target
-</em> Create TAG
-<em> Create and sign artefacts
-</em> Copy artefact and signatures to dev repo
-<em> Run the Vote
-</em> Tally the vote results
-<em> Stage release for mirroring by copying to release repo
-</em> Announce release (wait for mirror syncing) </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>
+</ul>
<h2 id="code-signing-keys">Code 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>
<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:
-<em> https://dist.apache.org/repos/dist/dev/incubator/celix/KEYS
-</em> https://dist.apache.org/repos/dist/release/incubator/celix/KEYS</p>
+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>
+</ul>
<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:
-<em> CHANGES
- Add a list of fixed issues which can be created using Jira.
-</em> RELEASE_NOTES
- Add additional notes regarding this release, eg known short comings.
-<em> BUILDING
- Even though the BUILDING file doesn't have any specific release information, it should be verified before making a release.
-</em> NOTICE
- If needed, add any new license related information to this file.</p>
+<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>If needed, add any new license related information to this file.</p>
+</li>
+</ul>
<p>Besides this information, the version needs to be bumped. Even though every bundle has its own version, a release is made with one overall version. This version
is defined in the top-level CMakeLists.txt file.
-Update the following pieces:
-SET(CELIX_MAJOR "X")
-SET(CELIX_MINOR "Y")
-SET(CELIX_MICRO "Z")
-SET(CELIX_QUALIFIER "incubating")
-While Celix is in incubation, the qualifier should (at least) always contain "incubating" as text.</p>
+Update the following pieces:</p>
+<ul>
+<li>SET(CELIX_MAJOR "X")</li>
+<li>SET(CELIX_MINOR "Y")</li>
+<li>SET(CELIX_MICRO "Z")</li>
+<li>SET(CELIX_QUALIFIER "incubating")</li>
+</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>
<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.
-Also verify that the provides examples work as expected. If needed ask other committers to test parts, eg the GTK examples.
-After verifying the build, run Apache RAT to check for any licensing problems. If Apache RAT is configured in the CMake build the "rat" target can be used to run
-the check: make rat
-Apache RAT should not raise any concers, if there are, check the source files for
+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>
+<p>After verifying the build, run Apache RAT to check for any licensing problems. If Apache RAT is configured in the CMake build the "rat" target can be used to run
+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>
-<p>After changing all files a tag for the new release must be made. Before doing so, make sure all changed files are committed.
-The tag should be named like this: celix-X.Y.Z.incubating
-To make a tag use the following command:
-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>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).
-See: http://www.apache.org/dev/release.html#host-rc</p>
+<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>
<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.
-The first vote has to be done on the public mailinglist of the project itself (celix-dev@incubator.apache.org). The following template must be used for this vote:
-================================================================================================================
+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 (celix-dev@incubator.apache.org). The following template must be used for this vote:</p>
+<p>================================================================================================================
To: celix-dev@incubator.apache.org
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 (https://issues.apache.org/jira/secure/ReleaseNote.jspa?version=12323511)}</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:
@@ -209,22 +219,34 @@ http://svn.apache.org/repos/asf/incubato
https://dist.apache.org/repos/dist/dev/incubator/celix/KEYS</p>
<p>Information for voting on a release can be found at http://www.apache.org/dev/release.html#approving-a-release</p>
<p>Please vote to approve this release:</p>
-<p>[ ] +1 Approve the release
-[ ] -1 Disapprove the release (please provide specific comments)</p>
-<h1 id="this-vote-will-be-open-for-at-least-72-hours">This vote will be open for at least 72 hours.</h1>
+<p>[ ] +1 Approve the release</p>
+<p>[ ] -1 Disapprove the release (please provide specific comments)</p>
+<p>This vote will be open for at least 72 hours.</p>
+<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.
-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:
-================================================================================================================
-This release has already been approved by:
-<em> Name of Approver (apache ID) (binding|not binding)
-</em> Name of Approver (apache ID) (binding|not binding)
-* ...
-See <link to markmail archive of Celix release thread> for their votes.
-================================================================================================================</p>
-<p>Todo: Check usability of http://wiki.apache.org/incubator/ReleaseChecklist
-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>
+has had enough time to review the release, following the defacto standard, this is ate 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>
+<table>
+<thead>
+<tr>
+<th>- Name of Approver (apache ID) (binding</th>
+<th>not binding)</th>
+</tr>
+</thead>
+<tbody>
+<tr>
+<td>- ...</td>
+<td></td>
+</tr>
+</tbody>
+</table>
+<p>See {link to markmail archive of Celix release thread} 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>
<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>
@@ -232,12 +254,12 @@ wether a vote is binding or not.</p>
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>
<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.
-See: http://www.apache.org/dev/release.html#upload-ci
-After these 24 hours the release can be announced. </p>
+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>After these 24 hours the release can be announced. </p>
<h2 id="announce-release">Announce release</h2>
-<p>Update website's "news section".
-Post message to "announce@apache.org"?</p>
+<p>Update website's "news section".</p>
+<p>Post message to "announce@apache.org"?</p>
</div>
<div id="homeright">