Author: marrs
Date: Mon Aug 20 15:23:01 2012
New Revision: 1375054
URL: http://svn.apache.org/viewvc?rev=1375054&view=rev
Log:
Added a first version of the release guide.
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=1375054&r1=1375053&r2=1375054&view=diff
==============================================================================
--- ace/site/trunk/content/dev-doc/release-guide.mdtext (original)
+++ ace/site/trunk/content/dev-doc/release-guide.mdtext Mon Aug 20 15:23:01 2012
@@ -1,4 +1,99 @@
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.
+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:
+
+* 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
+
+Before you can start staging a release candidate, you must:
+
+* Make sure there are no snapshot dependencies anymore.
+* Create a tagged version of the sources in preparation of the release
candidate.
+
+## Staging a release candidate
+
+Staging a release starts by checking out a tagged version of the sources:
+
+ $ svn co https://svn.apache.org/repos/asf/ace/tags/ace-sources-1.0.0
ace-sources-1.0.0
+
+The next step is to create the source archive:
+
+ $ cd build
+ $ ant -f src-build.xml package-src
+
+Then you sign the source archive, and create md5 and sha1 signatures for it:
+
+ $ ant -f src-build.xml sign-src
+
+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":
+
+ $ ant -f src-build.xml commit-to-staging
+
+## Voting on the release
+
+Start a vote on the [email protected] list:
+
+ To: "Apache ACE developers list" <[email protected]>
+ Subject: [VOTE] Release ACE version X.Y.Z
+
+ Please vote to approve this release:
+ [ ] +1 Approve the release
+ [ ] -1 Veto the release (please motivate)
+
+ This vote will be open for at least 72 hours.
+
+The formal requirements on 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.
+
+The list of PMC (and project) members can be found here:
http://ace.apache.org/get-involved/project-team.html
+
+Wrap up the vote with an e-mail to the [email protected] list again:
+
+ To: "Apache ACE developers list" <[email protected]>
+ Subject: [RESULT] [VOTE] Release ACE version X.Y.Z
+
+ The vote has passed/failed with the following result:
+ +1 (binding): ...
+ +1 (non-binding): ...
+ -1: ...
+
+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:
+
+ $ ant -f src-build.xml promote-to-release
+
+Then update the tag in subversion, for example for the 1.0.0 release like this:
+
+ $ svn move https://svn.apache.org/repos/asf/ace/tags/ace-sources-1.0.0
https://svn.apache.org/repos/asf/ace/releases/ace-sources-1.0.0 -m "Apache ACE
source release 1.0.0 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:
+
+ To: "Apache ACE users list" <[email protected]>
+ Subject: [ANN] ACE version X.Y.Z released.
+
+ The Apache ACE team is proud to announce the release of ACE version
X.Y.Z.
+
+ This release is available from our download page at:
+ http://ace.apache.org/downloads.html
+
+
+## Cancelling the release
+
+Remove the artifacts from the development area:
+
+ $ ant -f src-build.xml delete-from-staging
+
+We keep the tag in subversion for reference.
+
+
\ No newline at end of file
