You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by bu...@apache.org on 2015/07/30 13:04:57 UTC
svn commit: r960149 - in /websites/staging/sling/trunk/content: ./
documentation/development/release-management.html
Author: buildbot
Date: Thu Jul 30 11:04:57 2015
New Revision: 960149
Log:
Staging update by buildbot for sling
Modified:
websites/staging/sling/trunk/content/ (props changed)
websites/staging/sling/trunk/content/documentation/development/release-management.html
Propchange: websites/staging/sling/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Thu Jul 30 11:04:57 2015
@@ -1 +1 @@
-1693196
+1693409
Modified: websites/staging/sling/trunk/content/documentation/development/release-management.html
==============================================================================
--- websites/staging/sling/trunk/content/documentation/development/release-management.html (original)
+++ websites/staging/sling/trunk/content/documentation/development/release-management.html Thu Jul 30 11:04:57 2015
@@ -39,7 +39,18 @@
</div>
<div class="menu">
- <p><strong><a href="/documentation.html">Documentation</a></strong> <br />
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p><strong><a href="/documentation.html">Documentation</a></strong> <br />
<a href="/documentation/getting-started.html">Getting Started</a> <br />
<a href="/documentation/the-sling-engine.html">The Sling Engine</a> <br />
<a href="/documentation/development.html">Development</a> <br />
@@ -90,7 +101,18 @@
<h1>Release Management</h1>
- <p>Sling releases (and SNAPSHOTS) are deployed to the <a href="http://repository.apache.org">Nexus repository</a> instead of the traditional deployment via the Maven 2 mirrors source on <code>people.apache.org</code>. This makes the release process much leaner and simpler. In addtion we can benefit from the Apache Parent POM 6, which has most of the release profile setup built-in.</p>
+ <style type="text/css">
+/* The following code is added by mdx_elementid.py
+ It was originally lifted from http://subversion.apache.org/style/site.css */
+/*
+ * Hide class="elementid-permalink", except when an enclosing heading
+ * has the :hover property.
+ */
+.headerlink, .elementid-permalink {
+ visibility: hidden;
+}
+h2:hover > .headerlink, h3:hover > .headerlink, h1:hover > .headerlink, h6:hover > .headerlink, h4:hover > .headerlink, h5:hover > .headerlink, dt:hover > .elementid-permalink { visibility: visible }</style>
+<p>Sling releases (and SNAPSHOTS) are deployed to the <a href="http://repository.apache.org">Nexus repository</a> instead of the traditional deployment via the Maven 2 mirrors source on <code>people.apache.org</code>. This makes the release process much leaner and simpler. In addtion we can benefit from the Apache Parent POM 6, which has most of the release profile setup built-in.</p>
<p>Most of the hard work of preparing and deploying the release is done by Maven.</p>
<div class="toc">
<ul>
@@ -109,7 +131,7 @@
<li><a href="#appendix-c-deploy-bundles-on-the-sling-obr">Appendix C: Deploy bundles on the Sling OBR</a></li>
</ul>
</div>
-<h2 id="prerequisites">Prerequisites</h2>
+<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">¶</a></h2>
<ul>
<li>To prepare or perform a release you <em>MUST BE</em> at least be an Apache Sling Committer.</li>
<li>Each and every release must be signed; therefore the public key should be cross signed by other Apache committers (not required but suggested) and this public key should be added to <a href="https://people.apache.org/keys/group/sling.asc">https://people.apache.org/keys/group/sling.asc</a> and either on pool.sks-keyservers.net or pgp.mit.edu (See Appendix A)</li>
@@ -142,7 +164,7 @@
</pre></div>
-<h2 id="staging-the-release-candidates">Staging the Release Candidates</h2>
+<h2 id="staging-the-release-candidates">Staging the Release Candidates<a class="headerlink" href="#staging-the-release-candidates" title="Permanent link">¶</a></h2>
<p>First prepare your POMs for release:</p>
<ol>
<li>Make sure there are no snapshots in the POMs to be released</li>
@@ -207,7 +229,7 @@ $ <span class="n">mvn</span> <span class
</ul>
</li>
</ol>
-<h2 id="starting-the-vote">Starting the Vote</h2>
+<h2 id="starting-the-vote">Starting the Vote<a class="headerlink" href="#starting-the-vote" title="Permanent link">¶</a></h2>
<p>Propose a vote on the dev list with the closed issues, the issues left, and the staging repository - for example:</p>
<div class="codehilite"><pre><span class="n">To</span><span class="p">:</span> "<span class="n">Sling</span> <span class="n">Developers</span> <span class="n">List</span>" <span class="o"><</span><span class="n">dev</span><span class="p">@</span><span class="n">sling</span><span class="p">.</span><span class="n">apache</span><span class="p">.</span><span class="n">org</span><span class="o">></span>
<span class="n">Subject</span><span class="p">:</span> <span class="p">[</span><span class="n">VOTE</span><span class="p">]</span> <span class="n">Release</span> <span class="n">Apache</span> <span class="n">Sling</span> <span class="n">ABC</span> <span class="n">version</span> <span class="n">X</span><span class="p">.</span><span class="n">Y</span><span class="p">.</span><span class="n">Z</span>
@@ -239,7 +261,7 @@ $ <span class="n">mvn</span> <span class
</pre></div>
-<h2 id="wait-for-the-results">Wait for the Results</h2>
+<h2 id="wait-for-the-results">Wait for the Results<a class="headerlink" href="#wait-for-the-results" title="Permanent link">¶</a></h2>
<p>From <a href="http://www.apache.org/foundation/voting.html">Votes on Package Releases</a>:</p>
<blockquote>
<p>Votes on whether a package is ready to be released follow a format similar to majority
@@ -268,16 +290,16 @@ project to project, but the 'minimum of
<p>Be sure to include all votes in the list and indicate which votes were binding. Consider -1 votes very carefully. While there is technically no veto on release votes, there may be reasons for people to vote -1. So sometimes it may be better to cancel a release when someone, especially a member of the PMC, votes -1.</p>
-<p>If the vote is unsuccessful, you need to fix the issues and restart the process - see <em>Canceling the Release</em>.</p>
+<p>If the vote is unsuccessful, you need to fix the issues and restart the process - see <em>Canceling the Release</em>. Note that any changes to the artifacts under vote require a restart of the process, no matter how trivial. When restarting a vote version numbers must not be reused, since binaries might have already been copied around.</p>
<p>If the vote is successful, you need to promote and distribute the release - see <em>Promoting the Release</em>.</p>
-<h2 id="canceling-the-release">Canceling the Release</h2>
+<h2 id="canceling-the-release">Canceling the Release<a class="headerlink" href="#canceling-the-release" title="Permanent link">¶</a></h2>
<p>If the vote fails, or you decide to redo the release:</p>
<ol>
<li>Remove the release tag from Subversion (<code>svn del ...</code>)</li>
<li>Login to <a href="https://repository.apache.org">https://repository.apache.org</a> using your Apache SVN credentials. Click on <em>Staging</em> on the left. Then click on <em>org.apache.sling</em> in the list of repositories. In the panel below you should see a closed repository that is linked to your username and IP (if it's not yet closed you need to right click and select <em>Close</em>). Right click on this repository and select <em>Drop</em>.</li>
<li>Rollback the version in the <code>pom.xml</code> and commit any fixes you need to make</li>
</ol>
-<h2 id="promoting-the-release">Promoting the Release</h2>
+<h2 id="promoting-the-release">Promoting the Release<a class="headerlink" href="#promoting-the-release" title="Permanent link">¶</a></h2>
<p>If the vote passes:</p>
<ol>
<li>Commit the released artifacts to <a href="https://dist.apache.org/repos/dist/release/sling/">https://dist.apache.org/repos/dist/release/sling/</a> which is replicated to <a href="http://www.apache.org/dist/sling/">http://www.apache.org/dist/sling/</a> quickly via svnpubsub. Hint: use svn import to avoid having to checkout the whole folder first. The easiest to do this is to get the released artifact using the check script (check_staged_release.sh) and then simply copy the artifacts from the downloaded folder to your local checkout folder. Make sure to not add the checksum files for the signature file *.asc.*).</li>
@@ -289,12 +311,12 @@ project to project, but the 'minimum of
<li>Update the download page on the website at <a href="/downloads.cgi">downloads</a> to point to the new release.</li>
</ol>
<p>For the last two tasks, it's better to give the mirrors some time to distribute the uploaded artifacts (one day should be fine). This ensures that once the website (news and download page) is updated, people can actually download the artifacts.</p>
-<h2 id="update-jira">Update JIRA</h2>
+<h2 id="update-jira">Update JIRA<a class="headerlink" href="#update-jira" title="Permanent link">¶</a></h2>
<p>Go to <a href="https://issues.apache.org/jira/plugins/servlet/project-config/SLING/versions">Manage Versions</a> section on the SLING JIRA and mark the X.Y.Z version as released setting the release date to the date the vote has been closed.</p>
<p>Also create a new version X.Y.Z+2, if that hasn't already been done.</p>
<p>And keep the versions sorted, so when adding a new version moved it down to just above the previous versions.</p>
<p>Close all issues associated with the released version.</p>
-<h2 id="create-an-announcement">Create an Announcement</h2>
+<h2 id="create-an-announcement">Create an Announcement<a class="headerlink" href="#create-an-announcement" title="Permanent link">¶</a></h2>
<p>We usually do such announcements only for "important" releases, as opposed to small individual module
releases which are just announced on our <a href="/news.html">news</a> page.</p>
<div class="codehilite"><pre>To: "Sling Developers List" <span class="nt"><dev</span><span class="err">@sling.apache.org</span><span class="nt">></span>, "Apache Announcements" <span class="nt"><announce</span><span class="err">@apache.org</span><span class="nt">></span>
@@ -330,12 +352,12 @@ Enjoy!
<p><em>Important</em>: Add the release to the Software section of the next board report below <a href="https://cwiki.apache.org/confluence/display/SLING/Reports">Reports</a>.</p>
-<h2 id="related-links">Related Links</h2>
+<h2 id="related-links">Related Links<a class="headerlink" href="#related-links" title="Permanent link">¶</a></h2>
<ol>
<li><a href="http://www.apache.org/dev/release-signing.html">http://www.apache.org/dev/release-signing.html</a></li>
<li><a href="http://wiki.apache.org/incubator/SigningReleases">http://wiki.apache.org/incubator/SigningReleases</a></li>
</ol>
-<h2 id="releasing-the-sling-ide-tooling">Releasing the Sling IDE Tooling</h2>
+<h2 id="releasing-the-sling-ide-tooling">Releasing the Sling IDE Tooling<a class="headerlink" href="#releasing-the-sling-ide-tooling" title="Permanent link">¶</a></h2>
<p>While the Sling IDE tooling is built using Maven, the toolchain that it is based around does not cooperate well with the maven-release-plugin. As such, the release preparation and execution are slightly different. The whole process is outlined below, assuming that we start with a development version of 1.0.1-SNAPSHOT.</p>
<ol>
<li>set the fix version as released: <code>mvn tycho-versions:set-version -DnewVersion=1.0.2</code></li>
@@ -396,7 +418,7 @@ Enjoy!
</pre></div>
</td></tr></table>
-<h2 id="appendix-a-create-and-add-your-key-to-httpspeopleapacheorgkeysgroupslingasc">Appendix A: Create and Add your key to <a href="https://people.apache.org/keys/group/sling.asc">https://people.apache.org/keys/group/sling.asc</a></h2>
+<h2 id="appendix-a-create-and-add-your-key-to-httpspeopleapacheorgkeysgroupslingasc">Appendix A: Create and Add your key to <a href="https://people.apache.org/keys/group/sling.asc">https://people.apache.org/keys/group/sling.asc</a><a class="headerlink" href="#appendix-a-create-and-add-your-key-to-httpspeopleapacheorgkeysgroupslingasc" title="Permanent link">¶</a></h2>
<p>Considering that you are using a *nix system with a working OpenSSH, GnuPG, and bash you can create and add your own key with the following command:</p>
<ol>
<li>
@@ -421,7 +443,7 @@ When gpg asks for comment linked the key
<li>You are <em>DONE</em>, but to see the changes on <a href="https://people.apache.org/keys/group/sling.asc">https://people.apache.org/keys/group/sling.asc</a> you may need to wait a few hours</li>
</ol>
<p>You also have to add your public key either on pool.sks-keyservers.net or pgp.mit.edu (for the staging repository).</p>
-<h2 id="appendix-b-maven-and-scm-credentials">Appendix B: Maven and SCM credentials</h2>
+<h2 id="appendix-b-maven-and-scm-credentials">Appendix B: Maven and SCM credentials<a class="headerlink" href="#appendix-b-maven-and-scm-credentials" title="Permanent link">¶</a></h2>
<p>For running the <code>mvn release:prepare</code> command without giving credentials on command line add <code>svn.apache.org</code> to your <code>settings.xml</code>:</p>
<div class="codehilite"><pre><span class="nt"><server></span>
<span class="nt"><id></span>svn.apache.org<span class="nt"></id></span>
@@ -431,7 +453,7 @@ When gpg asks for comment linked the key
</pre></div>
-<h2 id="appendix-c-deploy-bundles-on-the-sling-obr">Appendix C: Deploy bundles on the Sling OBR</h2>
+<h2 id="appendix-c-deploy-bundles-on-the-sling-obr">Appendix C: Deploy bundles on the Sling OBR<a class="headerlink" href="#appendix-c-deploy-bundles-on-the-sling-obr" title="Permanent link">¶</a></h2>
<p>We are mainting an OSGi Bundle Repository providing all release of the Sling Bundles. This repository is maintained as part of the Apache Sling site and is available at <a href="http://sling.apache.org/obr/sling.xml">http://sling.apache.org/obr/sling.xml</a>. The source for this page is maintained in the SVN repository below the <em>site</em>, that is at <a href="http://svn.apache.org/repos/asf/sling/site/">http://svn.apache.org/repos/asf/sling/site/</a>. To update the Sling OBR repository you must be an Apache Sling Committer since this requires SVN write access.</p>
<p>To update the OBR you may use the Apache Felix Maven Bundle Plugin which prepares the bundle descriptor to be added to the OBR file. Follow these steps to update the OBR:</p>
<ol>
@@ -491,7 +513,7 @@ update your checkout and then publish th
</li>
</ol>
<div class="timestamp" style="margin-top: 30px; font-size: 80%; text-align: right;">
- Rev. 1633320 by bdelacretaz on Tue, 21 Oct 2014 09:08:37 +0000
+ Rev. 1693409 by rombert on Thu, 30 Jul 2015 11:04:43 +0000
</div>
<div class="trademarkFooter">
Apache Sling, Sling, Apache, the Apache feather logo, and the Apache Sling project