You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airavata.apache.org by sm...@apache.org on 2012/05/06 06:04:21 UTC
svn commit: r1334550 - in /incubator/airavata/site/trunk:
content/airavata/development/release-management.mdtext
templates/sidenav.mdtext
Author: smarru
Date: Sun May 6 04:04:21 2012
New Revision: 1334550
URL: http://svn.apache.org/viewvc?rev=1334550&view=rev
Log:
adding partially complete release management instructions
Added:
incubator/airavata/site/trunk/content/airavata/development/release-management.mdtext
Modified:
incubator/airavata/site/trunk/templates/sidenav.mdtext
Added: incubator/airavata/site/trunk/content/airavata/development/release-management.mdtext
URL: http://svn.apache.org/viewvc/incubator/airavata/site/trunk/content/airavata/development/release-management.mdtext?rev=1334550&view=auto
==============================================================================
--- incubator/airavata/site/trunk/content/airavata/development/release-management.mdtext (added)
+++ incubator/airavata/site/trunk/content/airavata/development/release-management.mdtext Sun May 6 04:04:21 2012
@@ -0,0 +1,87 @@
+Title: Release Process
+Notice: Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+ .
+ http://www.apache.org/licenses/LICENSE-2.0
+ .
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+Releases are crucial aspects for an apache project and following the guidelines is very important.
+The [Release FAQ][release-faq] describes the foundation wide policies. The [Incubator Release Management][inc-release-mgmt]
+describes incubator project specific release process. The following instructions walkthrough Airavata specific release steps.
+
+<a name="release-setup" />
+###One time release management setup
+
+This section describes release management configuration steps, if you have previously configured these steps,
+jump directly to ([Release Process](#release-process)).
+
+Performing a release will require:
+
+* Access to people.apache.org to stage builds, verify access by following these ([instructions](#access-people)).
+* Generate, sign and upload gpg key, you can follow these ([gpg instructions](#gpg-key)).
+* Configure Maven and get access to Nexus Repo, more ([maven & nexus instructions](#maven-nexus-setup)).
+
+<a name="access-people" />
+####Access to people.apache.org
+ssh <asfid>@people.apache.org
+
+<a name="gpg-key" />
+#### Generate GPG key
+The releases have to be signed by public key cryptography signatures. Detailed instructions on why releases have to be signed are provided on [Release Signing][release-signing] page.
+The popular software used Open Pretty Good Privacy (OpenPGP) is the GPG. The [GPG instructions][gpg-keys] list out detailed steps on managing your keps.
+
+The steps can be summerized as:
+
+* Generate 4096 bits RSA key pair using gpg: `gpg --gen-key`.
+* Export the public key: `gpg --list-sigs <Real Name> && gpg --armor -- export <Real Name>`
+* Upload the public key to [SURFNET PGP][surfnet-pgp] or [MIT PGP][mit-pgp] servers.
+* Have your key signed by atleast three apache commiters, [key signing][key-sign] and [Henk Penning][henk-trust] websites provide instructions.
+* Add the signed public key to the KEYS file on [Airavata Dist SVN][airavata-dist-svn].
+
+<a name="maven-nexus-setup" />
+#### Maven Consiguration & Nexus Setup
+
+* Airavata requires Maven 3 or later to build and release
+* It is encouraged to use maven's password encryption capabilities and set the gpg password in
+~/.m2/settings.xml. Detailed instructions are at [Publishing Maven Artifacts][maven-artificats]
+* Performing release will require maven to run series of commands, the heapsize has to be increased
+to avoid out of memory exceptions. For bash shell: `export MAVEN_OPTS="-Xmx1024m -XX:MaxPermSize=256m"`.
+For c shell: `setenv MAVEN_OPTS "-Xmx1024m -XX:MaxPermSize=256m"`.
+
+<a name="release-process" />
+#### Release Process
+
+1. Before performing the following release steps, ensure the [Release Setup](#release-setup) steps have been performed.
+
+2. Ensure the source is ready for release. Verify:
+ * Cleanup JIRA so the Fix Version in issues resolved since the last release includes this release version correctly.
+ * Ensure all open issues are resolved before proceeding further, close all resolved issues.
+ * Test and make sure the release passes all regression tests.
+ * Update RELEASE_NOTES with all the features added.
+ * Review and update README, INSTALL files.
+ * Commit any changes back to svn.
+ * Update website/wiki with Roadmap or Release landing pages.
+
+
+
+[release-faq]: http://www.apache.org/dev/release.html
+[inc-release-mgmt]: http://incubator.apache.org/guides/releasemanagement.html
+[gpg-keys]: http://www.apache.org/dev/openpgp.html
+[release-signing]: http://www.apache.org/dev/release-signing.html
+[surfnet-pgp]: http://pgp.surfnet.nl:11371/
+[mit-pgp]: http://pgp.mit.edu/
+[key-sign]: http://www.apache.org/dev/release-signing.html#key-signing-party
+[henk-trust]: http://people.apache.org/~henkp/trust/
+[maven-artificats]: http://www.apache.org/dev/publishing-maven-artifacts.html#dev-env
+[airavata-dist-svn]: https://dist.apache.org/repos/dist/release/incubator/airavata/
\ No newline at end of file
Modified: incubator/airavata/site/trunk/templates/sidenav.mdtext
URL: http://svn.apache.org/viewvc/incubator/airavata/site/trunk/templates/sidenav.mdtext?rev=1334550&r1=1334549&r2=1334550&view=diff
==============================================================================
--- incubator/airavata/site/trunk/templates/sidenav.mdtext (original)
+++ incubator/airavata/site/trunk/templates/sidenav.mdtext Sun May 6 04:04:21 2012
@@ -28,6 +28,7 @@
- [Road Map](/airavata/development/roadmap.html)
- [Dev Tools](/airavata/tools/devtools.html)
- [Editing Website](/airavata/development/edit-cms-website.html)
+ - [Release Management](/airavata/development/release-management.html)
# Documentation