syncope-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ilgro...@apache.org
Subject svn commit: r1330907 - /incubator/syncope/site/release-process.html
Date Thu, 26 Apr 2012 15:29:40 GMT
Author: ilgrosso
Date: Thu Apr 26 15:29:40 2012
New Revision: 1330907

URL: http://svn.apache.org/viewvc?rev=1330907&view=rev
Log:
Publishing draft release process page

Added:
    incubator/syncope/site/release-process.html   (with props)

Added: incubator/syncope/site/release-process.html
URL: http://svn.apache.org/viewvc/incubator/syncope/site/release-process.html?rev=1330907&view=auto
==============================================================================
--- incubator/syncope/site/release-process.html (added)
+++ incubator/syncope/site/release-process.html Thu Apr 26 15:29:40 2012
@@ -0,0 +1,560 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ | Generated by Apache Maven Doxia at Apr 26, 2012
+ | Rendered using Apache Maven Fluido Skin 1.2.1
+-->
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>
+    Apache Syncope</title>
+    <link rel="stylesheet" href="./css/apache-maven-fluido.min.css" />
+    <link rel="stylesheet" href="./css/site.css" />
+    <link rel="stylesheet" href="./css/print.css" media="print" />
+
+      
+    <script type="text/javascript" src="./js/apache-maven-fluido.min.js"></script>
+
+    
+      <meta name="author" content="Apache Syncope Documentation Team" />
+    <meta name="Date-Revision-yyyymmdd" content="20120426" />
+    <meta http-equiv="Content-Language" content="en" />
+    
+        </head>
+        <body class="topBarDisabled">
+          
+        
+    
+        <div class="container-fluid">
+          <div id="banner">
+        <div class="pull-left">
+                                                  <a href="./" id="bannerLeft">
+                                                                                        
       <img src="images/apache-syncope-logo-small.jpg" />
+                </a>
+                      </div>
+        <div class="pull-right">                                <a href="../" id="bannerRight">
+                                                                                        
       <img src="images/apache-incubator-logo.png" />
+                </a>
+      </div>
+        <div class="clear"><hr/></div>
+      </div>
+
+      <div id="breadcrumbs">
+        <ul class="breadcrumb">
+                
+                    
+                              <li class="">
+                    <a href="./" title="Apache Syncope">Apache Syncope</a>
+        <li class="divider ">/</li>
+      </li>
+    <li class="">
+    Apache Syncope</li>
+      
+                
+                    
+                  <li id="publishDate" class="pull-right">Last Published: 2012-04-26</li>
<li class="divider pull-right">|</li>
+              <li id="projectVersion" class="pull-right">Version: 1.0.0-incubating-SNAPSHOT</li>
+            
+                                  <li class="divider pull-right">|</li>
+                      
+    <li class="pull-right">              <a href="http://www.apache.org/" class="externalLink"
title="Apache">Apache</a>
+  </li>
+
+        <li class="divider pull-right">|</li>
+      
+    <li class="pull-right">              <a href="../" title="Apache Incubator">Apache
Incubator</a>
+  </li>
+
+                        </ul>
+      </div>
+
+            <div class="row-fluid">
+        <div id="leftColumn" class="span3">
+          <div class="well sidebar-nav">
+                
+                    
+                                    <h3>Project Information</h3>
+                  <ul>
+                  <li class="none">
+                          <a href="project-summary.html" title="Project Summary">Project
Summary</a>
+            </li>
+                  <li class="none">
+                          <a href="mail-lists.html" title="Mailing Lists">Mailing Lists</a>
+            </li>
+                  <li class="none">
+                          <a href="team-list.html" title="Project Team">Project Team</a>
+            </li>
+                  <li class="none">
+                          <a href="source-repository.html" title="Source Repository">Source
Repository</a>
+            </li>
+                  <li class="none">
+                          <a href="integration.html" title="Continuous Integration">Continuous
Integration</a>
+            </li>
+                  <li class="none">
+                          <a href="issue-tracking.html" title="Issue Tracking">Issue
Tracking</a>
+            </li>
+                  <li class="none">
+                          <a href="dependency-management.html" title="Dependency Management">Dependency
Management</a>
+            </li>
+                  <li class="none">
+                          <a href="plugin-management.html" title="Plugin Management">Plugin
Management</a>
+            </li>
+                  <li class="none">
+                          <a href="plugins.html" title="Project Plugins">Project Plugins</a>
+            </li>
+                  <li class="none">
+                          <a href="license.html" title="Project License">Project License</a>
+            </li>
+          </ul>
+                        <h3>Documentation</h3>
+                  <ul>
+                  <li class="none">
+                          <a href="features.html" title="Features">Features</a>
+            </li>
+                  <li class="none">
+                          <a href="architecture.html" title="Architecture">Architecture</a>
+            </li>
+                  <li class="none">
+                          <a href="http://cwiki.apache.org/confluence/display/SYNCOPE/Index"
class="externalLink" title="Wiki">Wiki</a>
+            </li>
+                  <li class="none">
+                          <a href="apidocs/index.html" title="Javadoc">Javadoc</a>
+            </li>
+          </ul>
+                        <h3>ASF</h3>
+                  <ul>
+                  <li class="none">
+                          <a href="http://www.apache.org/foundation/how-it-works.html"
class="externalLink" title="How Apache Works">How Apache Works</a>
+            </li>
+                  <li class="none">
+                          <a href="http://www.apache.org/foundation/" class="externalLink"
title="Foundation">Foundation</a>
+            </li>
+                  <li class="none">
+                          <a href="http://www.apache.org/foundation/sponsorship.html"
class="externalLink" title="Sponsoring Apache">Sponsoring Apache</a>
+            </li>
+                  <li class="none">
+                          <a href="http://www.apache.org/foundation/thanks.html" class="externalLink"
title="Thanks">Thanks</a>
+            </li>
+          </ul>
+                      
+                    
+                
+          <hr class="divider" />
+
+           <div id="poweredBy">
+                            <div class="clear"></div>
+                            <div class="clear"></div>
+                            <div class="clear"></div>
+                             <a href="http://maven.apache.org/" title="Built by Maven"
class="poweredBy">
+        <img class="poweredBy" alt="Built by Maven" src="./images/logos/maven-feather.png"
/>
+      </a>
+                  </div>
+          </div>
+        </div>
+        
+        <div id="bodyColumn"  class="span9" >
+                                  
+            <!-- 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. -->
+
+  
+    <p>The Syncope team is using the 
+      <a class="externalLink" href="http://repository.apache.org">Apache Nexus repository</a>
for releasing SNAPSHOT and release artifacts.
+      More details on releasing artifacts and using Nexus can be found on the Maven website
at
+      <a class="externalLink" href="http://maven.apache.org/developers/release/apache-release.html">http://maven.apache.org/developers/release/apache-release.html</a>.
+    </p>
+    
+    <div class="section"><h2>Release steps<a name="Release_steps"></a></h2>
+      
+      <div class="section"><h3>Prepare the source for release<a name="Prepare_the_source_for_release"></a></h3>
+        <ol style="list-style-type: decimal">
+          <li>Clean up JIRA so the             
+            <b>Fix Version</b> in issues resolved since the last
+            release includes this release version correctly.  Also, transition any
+            <b>Resolved</b> issues to the 
+            <b>Closed</b> state.
+          </li>
+          <li>
+            Update the text files in a working copy of the project root:
+            <ol style="list-style-type: decimal">
+              <li>Update the 
+                <tt>CHANGES</tt> based on the Text release reports from JIRA.
+              </li>
+              <li>Review and update 
+                <tt>README</tt> if needed.
+              </li>
+              <li>
+                Commit any changes back to svn:
+                <div class="source"><pre class="prettyprint">svn commit -m &quot;updating
files for release&quot;</pre></div>
+              </li>
+            </ol>
+          </li>
+          <li>
+            Perform a full build and deploy the SNAPSHOT artifacts:
+            <div class="source"><pre class="prettyprint">mvn -P apache-release
clean deploy</pre></div>
+          </li>
+        </ol>
+      </div>
+      
+      <div class="section"><h3>Get source tree<a name="Get_source_tree"></a></h3>
+        <ol style="list-style-type: decimal">
+          <li>
+            <b>
+              <i>Only for new major releases (like 1.0.0 to 1.1.0):</i>
+            </b>
+            <br />
+            Create a sub-branch from which to make the release.
+            <br />
+            Releasing from a branch will allow any cosmetic changes that need to be made
for the release to be 
+            approved to be done without preventing other more disruptive advances in the
trunk from potentially 
+            causing problems with the release. It also provides a future maintenance branch
(like 1.0.x.)
+            <br />
+            A branch can be made by running:
+            <div class="source"><pre class="prettyprint">mvn release:branch -DbranchName=1.0.x</pre></div>
+          </li>
+          <li>
+            Checkout a clean copy of the trunk/branch to release using command line svn:
+            <div class="source"><pre class="prettyprint">svn checkout https://svn.apache.org/repos/asf/incubator/syncope/trunk/
release</pre></div>
+          </li>
+        </ol>
+      </div>
+      
+      <div class="section"><h3>Prepare the release<a name="Prepare_the_release"></a></h3>
+        <ol style="list-style-type: decimal">
+          <li>
+            Do a dry run of the 
+            <tt>release:prepare</tt> step.
+            <div class="source"><pre class="prettyprint">mvn -Papache-release
release:prepare -DdryRun=true</pre></div>
+
+            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.
+          
+            <p>
+              <i>If you cancel a 
+                <tt>release:prepare</tt> before it updates the pom.xml versions,
then use the 
+                <tt>release:clean</tt> goal to just remove the extra files that
were created.
+              </i>
+            </p>
+          </li>
+          <li>
+            Verify that the release process completed as expected:
+            <ol style="list-style-type: decimal">
+              <li>The release plugin will create 
+                <tt>pom.xml.tag</tt> files which contain the
+                changes that would have been committed to SVN. The only differences between
+                <tt>pom.xml.tag</tt> and its corresponding 
+                <tt>pom.xml</tt> file should be the version
+                number.
+              </li>
+              <li>
+                If other formatting changes have been made you should review the changes
and then commit them:
+                <div class="source"><pre class="prettyprint">svn commit -m &quot;fixing
formatting for release&quot;</pre></div>
+              </li>
+              <li>
+                Assuming the 
+                <tt>.tag</tt> files look OK you may proceed and do any other
validation you feel necessary.
+                The following list may be helpful:
+                <ol style="list-style-type: decimal">
+                  <li>Check 
+                    <tt>release.properties</tt> 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: On Un*x platforms the following command can be executed:
+<div class="source"><pre class="prettyprint">for file in `find . -type f -iname
'*.asc'`
+do
+  gpg --verify ${file} 
+done</pre></div>
+                    You'll need to look at the output to ensure it contains only good signatures:
+<div class="source"><pre class="prettyprint">gpg: Good signature from ...
+gpg: Signature made ...</pre></div>
+                  </li>
+                </ol>
+              </li>
+              <li>
+                Once any failures or required updates have been committed to svn, rollback
the release prepare files:
+                <div class="source"><pre class="prettyprint">mvn -P apache-release
release:rollback</pre></div>
+              </li>
+            </ol>
+          </li>
+          <li>
+            Run the 
+            <tt>release:prepare</tt> step for real this time. You'll be prompted
for the same version information and 
+            optionally your GPG passphrase again.
+            <div class="source"><pre class="prettyprint">mvn -P apache-release
release:prepare</pre></div>
+          </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.
+<div class="source"><pre class="prettyprint">cd ..
+tar -czf 1.0-rc1.tar.gz 1.0-rc1/
+cd 1.0-rc1</pre></div>
+          </li>
+        </ol>
+      </div>
+      
+      <div class="section"><h3>Perform the release<a name="Perform_the_release"></a></h3>
+        This step will create a maven staging repository
+        <div class="source"><pre class="prettyprint">mvn -P apache-release release:perform</pre></div>
+        
+        <ol style="list-style-type: decimal">
+          <li>Verify the staged artifacts in the Nexus repository:
+            <ol style="list-style-type: decimal">
+              <li>
+                <a class="externalLink" href="https://repository.apache.org/index.html">https://repository.apache.org/index.html</a>
+              </li>
+              <li>
+                <b>Enterprise --&gt; Staging</b>
+              </li>
+              <li>
+                <b>Staging tab --&gt; Name column --&gt; org.apache.syncope</b>
+              </li>
+              <li>Navigate through the artifact tree and make sure that all binary,

+                <tt>javadoc</tt>,
+                <tt>sources</tt>, and 
+                <tt>tests</tt> jars, as well as 
+                <tt>pom</tt>s, ... have 
+                <tt>.asc</tt> (GPG signature) and 
+                <tt>.md5</tt>
+                files (see 
+                <a class="externalLink" href="http://people.apache.org/~henkp/repo/faq.html">Repository
FAQ</a> and 
+                <a class="externalLink" href="http://www.apache.org/dev/release-signing.html#openpgp-ascii-detach-sig">Detached
Signatures</a>).
+                The 
+                <tt>syncope-source.tar.gz</tt> and 
+                <tt>syncope-source.zip</tt> of 
+                <tt>syncope-root</tt>
+                should likewise have signature and checksum files.
+              </li>
+            </ol>
+          </li>
+          <li>Close the nexus staging repo:
+            <ol style="list-style-type: decimal">
+              <li>
+                <a class="externalLink" href="https://repository.apache.org/index.html">https://repository.apache.org/index.html</a>
+              </li>
+              <li>
+                <b>Enterprise --&gt; Staging</b>
+              </li>
+              <li>
+                <b>Staging tab --&gt; Name column --&gt; org.apache.syncope</b>
+              </li>
+              <li>Right click on the open 
+                <tt>org.apache.syncope-XXX</tt> staging repo
+                and select 
+                <b>Close</b>.
+              </li>
+            </ol>
+          </li>
+        </ol>
+      </div>
+      
+      <div class="section"><h3>Vote the Release<a name="Vote_the_Release"></a></h3>
+        <ol style="list-style-type: decimal">
+          <li>
+            Create a 
+            <tt>VOTE</tt> email thread on 
+            <a class="externalLink" href="mailto:syncope-dev@incubator.apache.org">syncope-dev</a>
to record votes as replies, e.g.:
+            <div><pre>
+To: syncope-dev@incubator.apache.org
+Subject: [VOTE] Apache Syncope &lt;version&gt;
+
+I've created a &lt;version&gt; release, with the following artifacts up for a vote:
+
+SVN source tag (r9999999):
+https://svn.apache.org/repos/asf/incubator/syncope/tags/&lt;version&gt;/
+
+Maven staging repo:
+https://repository.apache.org/content/repositories/orgapachesyncope-YYY/
+
+Source release:
+https://repository.apache.org/content/repositories/orgapachesyncope-YYY/org/apache/syncope/syncope-root/&lt;version&gt;/syncope-&lt;version&gt;-source.tar.gz
+https://repository.apache.org/content/repositories/orgapachesyncope-YYY/org/apache/syncope/syncope-root/&lt;version&gt;/syncope-&lt;version&gt;-source.zip
+
+PGP release keys (signed using ABCDEFG):
+http://www.apache.org/dist/incubator/syncope/KEYS
+
+Vote will be open for 72 hours.
+
+[ ] +1  approve
+[ ] +0  no opinion
+[ ] -1  disapprove (and reason why)
+            </pre></div>
+          </li>
+          <li>
+            Create a DISCUSS email thread on syncope-dev@ for any vote questions, e.g.:
+            <div><pre>
+To: syncope-dev@incubator.apache.org
+Subject: [DISCUSS] Apache Syncope &lt;version&gt;
+
+Discussion thread for vote on &lt;version&gt; release candidate, with SVN source
tag (r9999999).
+
+For more information on the release process, check out http://www.apache.org/dev/release.html
+
+Some of the things to check before voting are:
+ - does &quot;mvn apache-rat:check&quot; pass on the source
+ - can you build the contents of source-release.zip and svn tag
+ - do all of the staged jars/zips contain the required LICENSE and NOTICE files
+ - are all of the staged jars signed and the signature verifiable
+ - is the signing key in the project's KEYS file and on a public server (i.e. http://www.apache.org/dist/incubator/syncope/)
+            </pre></div>
+          </li>
+          <li>
+            Perform a review of the release and cast your vote. For more details on Apache
releases see
+            <a class="externalLink" href="http://www.apache.org/dev/release.html">http://www.apache.org/dev/release.html</a>.
+          </li>
+          <li>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 &quot;Recovering from a vetoed release&quot; below).
+          </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:
+            <ol style="list-style-type: decimal">
+              <li>Reply to the initial email prepending 
+                <tt>[RESULT]</tt> to the original subject
+              </li>
+              <li>Include a list of every binding +1, 0 or -1 vote.</li>
+            </ol>
+          </li>
+        </ol>
+      </div>
+      
+      <div class="section"><h3>Finalize the Release<a name="Finalize_the_Release"></a></h3>
+        <ol style="list-style-type: decimal">
+          <li>Promote the staged nexus artifacts:
+            <ol style="list-style-type: decimal">
+              <li>
+                <a class="externalLink" href="https://repository.apache.org/index.html">https://repository.apache.org/index.html</a>
+              </li>
+              <li>
+                <b>Enterprise --&gt; Staging</b>
+              </li>
+              <li>
+                <b>Staging tab --&gt; Name column --&gt; org.apache.syncope</b>
+              </li>
+              <li>Right click on the closed 
+                <tt>org.apache.syncope-XXX</tt> staging repo and select 
+                <b>Release</b>.
+              </li>
+            </ol>
+          </li>
+          <li>
+            Add the distribution artifacts to the distribution area
+            <p>
+              <b>TO BE COMPLETED</b>
+            </p>
+          </li>
+          <li>
+            Update the 
+            <i>Downloads</i> site page to point to the new release artifacts
+            <p>
+              <b>TO BE COMPLETED</b>
+            </p>
+          </li>
+          <li>
+            <p>Update the 
+              <a class="externalLink" href="https://issues.apache.org/jira/plugins/servlet/project-config/SYNCOPE/versions">JIRA
versions</a>
+              page to mark the version as 
+              <b>Released</b>, 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>
+        </ol>
+      </div>
+      
+      <div class="section"><h3>Announce the Release<a name="Announce_the_Release"></a></h3>
+        Make an announcement about the release on the
+        <a class="externalLink" href="mailto:syncope-user@incubator.apache.org">syncope-user</a>,
+        <a class="externalLink" href="mailto:syncope-dev@incubator.apache.org">syncope-dev</a>,
and
+        <a class="externalLink" href="mailto:announce@apache.org">announce@apache.org</a>
lists as per
+        <a class="externalLink" href="http://www.apache.org/foundation/mailinglists.html#foundation-announce]">the
Apache Announcement Mailing Lists page</a>
+      </div>
+    </div>
+    
+    <div class="section"><h2>Recovering from a vetoed release<a name="Recovering_from_a_vetoed_release"></a></h2>
+      <ol style="list-style-type: decimal">
+        <li>
+          <p>Reply to the initial vote email prepending 
+            <tt>[CANCELED]</tt> to the original subject.
+          </p>
+        </li>
+        <li>
+          <p>Rollback the version upgrades in trunk by 
+            <i>either</i>:
+          </p>
+          <ol style="list-style-type: decimal">
+            <li>
+              Restore the 0.1-rc1.tar.gz and run
+              <div class="source"><pre class="prettyprint">mvn -P apache-release
release:rollback</pre></div> 
+              <i>or</i>:
+              manually revert the versions in trunk to the prior version and commit
+            </li>
+          </ol>
+        </li>
+        <li>
+          <p>Delete the svn tag created by the 
+            <tt>release:perform</tt> step:
+          </p>
+          <div class="source"><pre class="prettyprint">svn rm https://svn.apache.org/repos/asf/incubator/syncope/tags/1.0
-m &quot;deleting tag from rolled back release&quot;</pre></div>
+        </li>
+        <li>
+          <p>Drop the nexus staging repo:</p>
+          <ol style="list-style-type: decimal">
+            <li>
+              <a class="externalLink" href="https://repository.apache.org/index.html">https://repository.apache.org/index.html</a>
+            </li>
+            <li>
+              <b>Enterprise --&gt; Staging</b>
+            </li>
+            <li>
+              <b>Staging tab --&gt; Name column --&gt; org.apache.syncope</b>
+            </li>
+            <li>Right click on the closed 
+              <tt>org.apache.syncope-XXX</tt> staging repo and select 
+              <b>Drop</b>.
+            </li>
+          </ol>
+        </li>
+        <li>
+          Make the required updates that caused the vote to be canceled.
+        </li>
+        <li>Spin another release attempt!</li>
+      </ol>
+    </div>
+  
+
+                  </div>
+            </div>
+      
+    <hr/>
+
+    <footer>
+            <div class="container-fluid">
+              <div class="row span16">Copyright &copy;                    2010-2012
+                        <a href="http://www.apache.org/">The Apache Software Foundation</a>.
+            All Rights Reserved.      
+                    
+      </div>
+
+                                          <?xml version="1.0" encoding="UTF-8"?>
+<div style="width:100%" class="row span16">Apache, Syncope, Apache Syncope, the Apache
feather logo, the Apache Syncope project logo and the Apache Syncope logo are trademarks of
The Apache Software Foundation. All other marks mentioned may be trademarks or registered
trademarks of their respective owners.</div>
+                  
+        
+                </div>
+    </footer>
+  </body>
+</html>

Propchange: incubator/syncope/site/release-process.html
------------------------------------------------------------------------------
    svn:eol-style = native

Propchange: incubator/syncope/site/release-process.html
------------------------------------------------------------------------------
    svn:keywords = Date Revision Author HeadURL Id

Propchange: incubator/syncope/site/release-process.html
------------------------------------------------------------------------------
    svn:mime-type = text/html



Mime
View raw message