airavata-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r820143 - in /websites/staging/airavata/trunk/content: ./ airavata/development/release-management.html
Date Sun, 03 Jun 2012 22:01:11 GMT
Author: buildbot
Date: Sun Jun  3 22:01:11 2012
New Revision: 820143

Log:
Staging update by buildbot for airavata

Modified:
    websites/staging/airavata/trunk/content/   (props changed)
    websites/staging/airavata/trunk/content/airavata/development/release-management.html

Propchange: websites/staging/airavata/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Sun Jun  3 22:01:11 2012
@@ -1 +1 @@
-1334550
+1345790

Modified: websites/staging/airavata/trunk/content/airavata/development/release-management.html
==============================================================================
--- websites/staging/airavata/trunk/content/airavata/development/release-management.html (original)
+++ websites/staging/airavata/trunk/content/airavata/development/release-management.html Sun
Jun  3 22:01:11 2012
@@ -92,20 +92,20 @@
     <p>Releases are crucial aspects for an apache project and following the guidelines
is very important.
 The <a href="http://www.apache.org/dev/release.html">Release FAQ</a> describes
the foundation wide policies. The <a href="http://incubator.apache.org/guides/releasemanagement.html">Incubator
Release Management</a>
 describes incubator project specific release process. The following instructions walkthrough
Airavata specific release steps. </p>
-<p><a name="release-setup" /></p>
+<p><a name="release-setup"></a></p>
 <h3 id="one-time-release-management-setup">One time release management setup</h3>
 <p>This section describes release management configuration steps, if you have previously
configured these steps, 
-jump directly to (<a href="#release-process">Release Process</a>).</p>
+jump directly to <a href="#release-process">Release Process</a>.</p>
 <p>Performing a release will require:</p>
 <ul>
-<li>Access to people.apache.org to stage builds, verify access by following these (<a
href="#access-people">instructions</a>).</li>
-<li>Generate, sign and upload gpg key, you can follow these (<a href="#gpg-key">gpg
instructions</a>).</li>
-<li>Configure Maven and get access to Nexus Repo, more (<a href="#maven-nexus-setup">maven
&amp; nexus instructions</a>).</li>
+<li>Access to people.apache.org to stage builds, verify access by following these <a
href="#access-people">instructions</a>.</li>
+<li>Generate, sign and upload gpg key, you can follow these <a href="#gpg-key">gpg
instructions</a>.</li>
+<li>Configure Maven and get access to Nexus Repo, more <a href="#maven-nexus-setup">maven
&amp; nexus instructions</a>.</li>
 </ul>
-<p><a name="access-people" /></p>
+<p><a name="access-people"></a></p>
 <h4 id="access-to-peopleapacheorg">Access to people.apache.org</h4>
-<p>ssh <asfid>@people.apache.org</p>
-<p><a name="gpg-key" /></p>
+<p>Ensure you can access the apache gateway server by <code>ssh &lt;asfid&gt;@people.apache.org</code>.
If you have any trouble with your ASF LDAP, you can change or reset your password at <a
href="https://id.apache.org/">Apache Account Utility Page</a>.</p>
+<p><a name="gpg-key"></a></p>
 <h4 id="generate-gpg-key">Generate GPG key</h4>
 <p>The releases have to be signed by public key cryptography signatures. Detailed instructions
on why releases have to be signed are provided on <a href="http://www.apache.org/dev/release-signing.html">Release
Signing</a> page.
 The popular software used Open Pretty Good Privacy (OpenPGP) is the GPG. The <a href="http://www.apache.org/dev/openpgp.html">GPG
instructions</a> list out detailed steps on managing your keps.</p>
@@ -117,7 +117,7 @@ The popular software used Open Pretty Go
 <li>Have your key signed by atleast three apache commiters, <a href="http://www.apache.org/dev/release-signing.html#key-signing-party">key
signing</a> and <a href="http://people.apache.org/~henkp/trust/">Henk Penning</a>
websites provide instructions.</li>
 <li>Add the signed public key to the KEYS file on <a href="https://dist.apache.org/repos/dist/release/incubator/airavata/">Airavata
Dist SVN</a>.</li>
 </ul>
-<p><a name="maven-nexus-setup" /></p>
+<p><a name="maven-nexus-setup"></a></p>
 <h4 id="maven-consiguration-nexus-setup">Maven Consiguration &amp; Nexus Setup</h4>
 <ul>
 <li>Airavata requires Maven 3 or later to build and release</li>
@@ -127,7 +127,7 @@ The popular software used Open Pretty Go
 to avoid out of memory exceptions. For bash shell: <code>export MAVEN_OPTS="-Xmx1024m
-XX:MaxPermSize=256m"</code>. 
 For c shell: <code>setenv MAVEN_OPTS "-Xmx1024m -XX:MaxPermSize=256m"</code>.</li>
 </ul>
-<p><a name="release-process" /></p>
+<p><a name="release-process"></a></p>
 <h4 id="release-process">Release Process</h4>
 <ol>
 <li>
@@ -146,7 +146,231 @@ For c shell: <code>setenv MAVEN_OPTS "-X
 <li>Update website/wiki with Roadmap or Release landing pages.</li>
 </ul>
 </li>
+<li>
+<p>Checkout a clean copy of the trunk to release using command line svn.
+    <em>Do not use Eclipse to do the checkout. The extra dot (.) files created by Eclipse
throws off the rat:check processing.</em></p>
+</li>
+<li>
+<p>Verify the source has the required license headers before trying to release: <code>mvn
-P pedantic verify -DskipTests</code></p>
+</li>
+<li>
+<p>Do a dry run of the release:prepare step: 
+    <code>mvn -P apache-release release:prepare -DautoVersionSubmodules=true -DdryRun=true</code></p>
+<p>The dry run will not commit any changes back to SVN and gives you the opportunity
to verify that the release process will complete as expected. You will be prompted for the
following information :</p>
+<ul>
+<li>Release version</li>
+<li>SCM release tag</li>
+<li>New development version</li>
+<li>GPG Passprhase - On a Mac if the passphrase is stored in keychain, the passphrase
is not prompted. </li>
+</ul>
+<p><em>If you cancel a release:prepare before it updates the pom.xml versions,
then use the release:clean goal to just remove the extra files that were created.</em></p>
+<p>The Maven release plugin checks for SNAPSHOT dependencies in pom's. It will not
complete the prepare goal until all SNAPSHOT dependencies are resolved.</p>
+</li>
+<li>
+<p>Verify that the release process completed as expected</p>
+<ul>
+<li>The release plugin will create pom.xml.tag files which contain the changes that
would have been committed to SVN. The only differences between pom.xml.tag and it's corresponding
pom.xml file should be the version number.</li>
+<li>If other formatting changes have been made you should review the changes and then
commit them <code>svn commit -m "fixing formatting for release"</code><br />
+</li>
+<li>Check release.properties and make sure that the scm properties have the right version.
Sometimes the scm location can be the previous version not the next version.</li>
+<li>Verify signatures (<a href="#verify_signatures">Verifying release signatures</a>)</li>
+</ul>
+</li>
+<li>
+<p>Once any failures or required updates have been committed to svn, rollback the release
prepare files:  <code>mvn -P apache-release release:rollback</code></p>
+</li>
+<li>
+<p>Prepare the release</p>
+<ul>
+<li>Run the "release:prepare" step for real this time. You'll be prompted for the same
version information.
+<code>mvn -P apache-release release:prepare -DautoVersionSubmodules=true</code></li>
+<li>Backup (zip or tar) your local release candidate directory in case you need to
rollback the release after the next step is performed.</li>
+</ul>
+</li>
+<li>
+<p>Perform the release</p>
+<ul>
+<li>
+<p>This step will create a maven staging repository and site for use in testing and
voting. 
+ <code>mvn release:perform -Papache-release</code></p>
+</li>
+<li>
+<p>If your local OS userid doesn't match your Apache userid, then you'll have to also
override the value provided by the OS to Maven for the site-deploy step to work. This is known
to work for Linux, but not for Mac and unknown for Windows.*
+  -Duser.name=[your_apache_uid]</p>
+</li>
+</ul>
+</li>
+<li>
+<p>Verify the Nexus release artifacts</p>
+<ul>
+<li>
+<p>Verify the HTML links in site are correct</p>
+</li>
+<li>
+<p>Verify the staged artifacts in the nexus repo   <br />
+</p>
+<ul>
+<li>https://repository.apache.org/index.html</li>
+<li>Staging repositories (under Build Promotion) --&gt; Name column --&gt;
org.apache.airavata</li>
+<li>Navigate through the artifact tree and make sure that all javadoc, sources, tests,
jars, ... have .asc (GPG signature) and .md5 files. See http://people.apache.org/~henkp/repo/faq.html
and http://www.apache.org/dev/release-signing.html#openpgp-ascii-detach-sig</li>
+</ul>
+</li>
+<li>
+<p>Close the nexus staging repo</p>
+<ul>
+<li>https://repository.apache.org/index.html</li>
+<li>Staging repositories (under Build Promotion) --&gt; Name column --&gt;
org.apache.airavata</li>
+<li>Click checkbox for the open staging repo (org.apache.airavata-XXX) and press Close
in the menu bar.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>
+<p>Sign the binary artifacts</p>
+<div class="codehilite"><pre>* $ `cd modules/distribution/target`
+* $ `gpg -ab apache-airavata-*<span class="cp">${</span><span class="n">project</span><span
class="o">.</span><span class="n">version</span><span class="cp">}</span>*-incubating-bin.tar.gz`
+* $ `gpg -ab apache-airavata-*<span class="cp">${</span><span class="n">project</span><span
class="o">.</span><span class="n">version</span><span class="cp">}</span>*-incubating-bin.zip`
+* $ `gpg --print-md SHA512 apache-airavata-*<span class="cp">${</span><span
class="n">project</span><span class="o">.</span><span class="n">version</span><span
class="cp">}</span>*-incubating-bin.tar.gz &gt; apache-airavata-*<span class="cp">${</span><span
class="n">project</span><span class="o">.</span><span class="n">version</span><span
class="cp">}</span>*-incubating-bin.tar.gz.sha`
+* $ `gpg --print-md SHA512 apache-airavata-*<span class="cp">${</span><span
class="n">project</span><span class="o">.</span><span class="n">version</span><span
class="cp">}</span>*-incubating-bin.zip &gt; apache-airavata-*<span class="cp">${</span><span
class="n">project</span><span class="o">.</span><span class="n">version</span><span
class="cp">}</span>*-incubating-bin.zip.sha`
+* $ `gpg --print-md MD5 apache-airavata-*<span class="cp">${</span><span class="n">project</span><span
class="o">.</span><span class="n">version</span><span class="cp">}</span>*-incubating-bin.tar.gz
&gt; apache-airavata-*<span class="cp">${</span><span class="n">project</span><span
class="o">.</span><span class="n">version</span><span class="cp">}</span>*-incubating-bin.tar.gz.md5`
+* $ `gpg --print-md MD5 apache-airavata-*<span class="cp">${</span><span class="n">project</span><span
class="o">.</span><span class="n">version</span><span class="cp">}</span>*-incubating-bin.zip
&gt; apache-airavata-*<span class="cp">${</span><span class="n">project</span><span
class="o">.</span><span class="n">version</span><span class="cp">}</span>*-incubating-bin.zip.md5`
+</pre></div>
+
+
+</li>
+<li>
+<p>Stage the source and binary artifacts to a web staging area <br />
+        * $ <code>ssh people.apache.org mkdir /www/people.apache.org/builds/airavata/${project.version}</code>
+        * $ <code>scp .apache-airavata-*${project.version}*-incubating-bin.zip* ${user.name}@people.apache.org:/www/people.apache.org/builds/airavata/${project.version}/</code>
+        * $ <code>ssh people.apache.org cd /www/people.apache.org/builds/airavata/${project.version}</code>
+        * $ <code>wget https://repository.apache.org/content/repositories/releases/org/apache/airavata/${project.name}/${project.version}/${project.name}-${project.version}-source-release.zip</code>
 <br />
+        * $ <code>wget https://repository.apache.org/content/repositories/releases/org/apache/airavata/${project.name}/${project.version}/${project.name}-${project.version}-source-release.zip.asc</code>
<br />
+        * $ <code>wget https://repository.apache.org/content/repositories/releases/org/apache/airavata/${project.name}/${project.version}/${project.name}-${project.version}-source-release.zip.md5</code><br
/>
+        * $ <code>wget https://repository.apache.org/content/repositories/releases/org/apache/airavata/${project.name}/${project.version}/${project.name}-${project.version}-source-release.zip.sha1</code>
+        * Verify they are downloadable from http://people.apache.org/builds/airavata/${project.version}/</p>
+</li>
+<li>
+<p>Put the release candidate up for a vote</p>
+<ol>
+<li>Create a VOTE email thread on dev@ to record votes as replies, like <a href="release-vote.txt">this</a></li>
+<li>Create a DISCUSS email thread on dev@ for any vote questions, <a href="release-discuss.txt">this</a></li>
+<li>
+<p>Perform a review of the release and cast your vote. For elaborate instructions,
please consult <a href="http://www.apache.org/dev/release.html">Apache Release FAQ</a>
and <a href="http://incubator.apache.org/guides/releasemanagement.html">Incubator Release
Management</a> Guides.</p>
+</li>
+<li>
+<p>A -1 vote does not necessarily mean that the vote must be redone, however it is
usually a good idea to rollback the release if a -1 vote is received. See - Recovering from
a vetoed release</p>
+</li>
+<li>After the vote has been open for at least 72 hours, has at least three +1 PMC votes
and no -1 votes, then post the results to the vote thread by -<ul>
+<li>reply to the initial email and prepend to the original subject "[RESULT]"</li>
+<li>Include a list of everyone who voted +1, 0 or -1.</li>
+</ul>
+</li>
 </ol>
+</li>
+<li>
+<p>Finalizing a release</p>
+<ol>
+<li>
+<p>The artificats in the repository are not yet mirrored and available for maven to
download. Promote the staged nexus artifacts, but releasing them. <br />
+</p>
+<ul>
+<li>https://repository.apache.org/index.html</li>
+<li>Staging repositories (under Build Promotion) --&gt; Name column --&gt;
org.apache.airavata</li>
+<li>Click checkbox of the closed staging repo (org.apache.airavata-XXX) and select
Release.</li>
+</ul>
+</li>
+<li>
+<p>Checkin the source and binary artifcats into distribution svn which will be pulled
by all mirrors within 24 hours. <br />
+</p>
+<ul>
+<li>$ <code>svn co https://dist.apache.org/repos/dist/release/incubator/airavata
./airavata-releases</code>  (KEEP this directory until after the release process has
been completed)</li>
+<li>$ <code>cd ./airavata-releases</code></li>
+<li>$ <code>scp people.apache.org:/www/people.apache.org/builds/airavata/${project.version}/*
./</code></li>
+<li>$ <code>svn add ${project.name}-*</code></li>
+<li>$ <code>svn commit -m "Committing Airavata Source and Binary Release for
${project.name}-${project.version}</code></li>
+</ul>
+</li>
+<li>
+<p>Update the staged website</p>
+<ul>
+<li>Update the downloads page to add new version using the mirrored URLs</li>
+<li>Modify the URL for the prior release to the archived URL for the release</li>
+</ul>
+</li>
+<li>
+<p>Publish the website</p>
+<ul>
+<li>WAIT 24hrs after committing releases for mirrors to replicate</li>
+<li>Publish updates to the download page</li>
+</ul>
+</li>
+<li>
+<p>Delete the prior versions</p>
+<ul>
+<li>Navigate to the release directories checked out in the prior steps</li>
+<li>Delete the prior release artifacts using the svn delete command</li>
+<li>Commit the deletion</li>
+</ul>
+</li>
+</ol>
+</li>
+<li>
+<p>Update the JIRA versions page to close all issues, mark the version as "released",
and set the date to the date that the release was approved. You may also need to make a new
release entry for the next release.</p>
+</li>
+<li>
+<p>Announcing the release</p>
+<ul>
+<li>Make a news announcement on the Airavata homepage.</li>
+<li>Make an announcement about the release on the airavata-dev@incubator.apache.org,
and announce@apache.org.</li>
+</ul>
+</li>
+</ol>
+<h4 id="recovering-from-a-vetoed-release">Recovering from a vetoed release</h4>
+<ol>
+<li>
+<p>Reply to the initial vote email and prepend to the original subject -</p>
+<p>[CANCELED]</p>
+</li>
+<li>
+<p>Delete the svn tag created by the release:perform step -</p>
+<p>$ svn del https://svn.apache.org/repos/asf/airavata/tags/${project.version} -m "deleting
tag from rolled back release"</p>
+</li>
+<li>
+<p>Delete the build artifacts on people &amp; www         <br />
+</p>
+<ul>
+<li>$ rm -rfv /www/people.apache.org/builds/airavata/${project.version}</li>
+</ul>
+</li>
+<li>
+<p>Drop the nexus staging repo</p>
+<ol>
+<li>https://repository.apache.org/index.html</li>
+<li>Enterprise --&gt; Staging</li>
+<li>Staging tab --&gt; Name column --&gt; org.apache.airavata</li>
+<li>Right click on the closed staging repo (org.apache.airavata-XXX) and select Drop.</li>
+</ol>
+</li>
+<li>
+<p>Remove the staged site</p>
+</li>
+<li>
+<p>Make the required updates that caused the vote to be canceled during the next release
cycle</p>
+</li>
+</ol>
+<p><a name="verify_signatures"></a></p>
+<h4 id="verifying-release-signatures">Verifying release signatures</h4>
+<p>On unix platforms and mac's download all source and binary artifacts into a new
directory and cd to the download directory.</p>
+<div class="codehilite"><pre>  for file in `find . -type f -iname &#39;*.asc&#39;`
+  do
+      gpg --verify <span class="cp">${</span><span class="nb">file</span><span
class="cp">}</span> 
+  done
+</pre></div>
+
+
+<p>The output will indicate the You'll need to look at the output to ensure it contains
only good signatures -</p>
+<p>gpg: Good signature from ...
+gpg: Signature made ...</p>
   </div>
 
   <div id="footer">



Mime
View raw message