Author: jawi
Date: Thu Apr 17 08:44:02 2014
New Revision: 1588164
URL: http://svn.apache.org/r1588164
Log:
Updated the release guide:
- added line on how to verify the release artifacts in the email
template;
- enabled some of the links;
- some typo's fixed
Modified:
ace/site/trunk/content/dev-doc/release-guide.mdtext
Modified: ace/site/trunk/content/dev-doc/release-guide.mdtext
URL:
http://svn.apache.org/viewvc/ace/site/trunk/content/dev-doc/release-guide.mdtext?rev=1588164&r1=1588163&r2=1588164&view=diff
==============================================================================
--- ace/site/trunk/content/dev-doc/release-guide.mdtext (original)
+++ ace/site/trunk/content/dev-doc/release-guide.mdtext Thu Apr 17 08:44:02 2014
@@ -1,22 +1,25 @@
Title: Release Guide
-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 [Release
FAQ](http://www.apache.org/dev/release.html).
+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
+[Release FAQ](http://www.apache.org/dev/release.html).
## Prerequisites
-To create a release you must:
+To create a release you *must*:
-* Be a committer in the Apache ACE project.
-* Have ant installed on your system.
-* Have svn installed on your system.
-* Have gpg installed on your system.
-* Have a public key added to: http://www.apache.org/dist/ace/KEYS
+* Be a committer in the Apache ACE project;
+* Have Ant installed on your system;
+* Have Subversion installed on your system;
+* Have gpg installed on your system;
+* Have a public key added to the [keys
file](http://www.apache.org/dist/ace/KEYS).
Before you can start staging a release candidate, you must:
-* Make sure there are no snapshot dependencies anymore.
-* Double check that the version you want to create is correctly filled in in
build/build.xml.
-* Create a tagged version of the sources in preparation of the release
candidate.
+* Make sure there are no dependencies on snapshots/unreleased versions;
+* double check that the version you want to create is correctly filled in in
<tt>build/build.xml</tt>;
+* create a tagged version of the sources in preparation of the release
candidate.
## Staging a release candidate
@@ -37,14 +40,18 @@ Then you sign archives by invoking the f
:::sh
$ ant sign
-Now you can upload the archives and the signatures to our development area,
which we use to stage this release candidate. This development area can be
found at https://dist.apache.org/repos/dist/dev/ace and adding files to it can
be done using "svnpubsub" which is taken care of by the following target:
+you can upload the archives and the signatures to our development area, which
+we use to stage this release candidate. This development area can be found at
+<tt>https://dist.apache.org/repos/dist/dev/ace</tt> and adding files to it can
+be done using "svnpubsub" which is taken care of by the following target:
:::sh
$ ant commit-to-staging
## Voting on the release
-Start a vote on the [email protected] list:
+Start a vote on the [email protected] list, for example (be sure to replace
+<tt>X.Y.Z</tt> with the *correct* version!):
:::sh
To: "Apache ACE developers list" <[email protected]>
@@ -55,6 +62,13 @@ Start a vote on the [email protected] l
binary release for convenience. They can all be found in
our staging area here:
https://dist.apache.org/repos/dist/dev/ace/
+
+ You can use this UNIX script to download the release and
+ verify the checksums and signatures:
+ http://svn.apache.org/repos/asf/ace/trunk/etc/check_staged_ace.sh
+
+ Usage:
+ sh check_staged_ace.sh X.Y.Z
Please vote to approve this release:
[ ] +1 Approve the release
@@ -62,13 +76,20 @@ Start a vote on the [email protected] l
This vote will be open for at least 72 hours.
-The formal requirements on approving a release are:
+The formal requirements on [approving a
release](http://www.apache.org/dev/release.html#approving-a-release) are:
-> 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.
+> 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.
-The list of PMC (and project) members can be found here:
http://ace.apache.org/get-involved/project-team.html
+The list of PMC (and project) members can be found
+[on this page](http://ace.apache.org/get-involved/project-team.html).
-Wrap up the vote with an e-mail to the [email protected] list again:
+Wrap up the vote with an e-mail to the <tt>[email protected]</tt> list again:
To: "Apache ACE developers list" <[email protected]>
Subject: [RESULT] [VOTE] Release ACE version X.Y.Z
@@ -78,21 +99,26 @@ Wrap up the vote with an e-mail to the d
+1 (non-binding): ...
-1: ...
-And, depending on the result, continue with either promoting or cancelling the
release below.
+And, depending on the result, continue with either promoting or cancelling the
+release below.
## Promoting the release
-Move the artifacts from the development area to the final release location at
https://dist.apache.org/repos/dist/release/ace by invoking the following target:
+Move the artifacts from the development area to the final release location at
+<tt>https://dist.apache.org/repos/dist/release/ace</tt> by invoking the
+following target:
:::sh
$ ant promote-to-release
-Then update the tag in subversion, for example for the X.Y.Z release like this:
+Then update the tag in subversion, for example for the *X.Y.Z* release like
this:
:::sh
$ svn move https://svn.apache.org/repos/asf/ace/tags/ace-sources-X.Y.Z
https://svn.apache.org/repos/asf/ace/releases/ace-sources-X.Y.Z -m "Apache ACE
release X.Y.Z tagged."
-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:
+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:
To: "Apache ACE users list" <[email protected]>
Subject: [ANN] ACE version X.Y.Z released.
@@ -111,3 +137,4 @@ Remove the artifacts from the developmen
$ ant delete-from-staging
We keep the tag in subversion for reference.
+
