karaf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache Karaf > Release Guide
Date Fri, 16 Jul 2010 13:09:00 GMT
<html>
<head>
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/1810/9/3/_/styles/combined.css?spaceKey=KARAF&amp;forWysiwyg=true"
type="text/css">
    </head>
<body style="background: white;" bgcolor="white" class="email-body">
<div id="pageContent">
<div id="notificationFormat">
<div class="wiki-content">
<div class="email">
    <h2><a href="https://cwiki.apache.org/confluence/display/KARAF/Release+Guide">Release
Guide</a></h2>
    <h4>Page <b>edited</b> by             <a href="https://cwiki.apache.org/confluence/display/~jgoodyear">Jamie
Goodyear</a>
    </h4>
        <br/>
                         <h4>Changes (1)</h4>
                                 
    
<div id="page-diffs">
            <table class="diff" cellpadding="0" cellspacing="0">
            <tr><td class="diff-snipped" >...<br></td></tr>
            <tr><td class="diff-unchanged" >* Use Maven 2.0.11 or greater. <br>*
JDK 1.5 (We try to maintain compatibility) <br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">*
Install [princexml|http://www.princexml.com/] 7.1 for manual generation. <br></td></tr>
            <tr><td class="diff-unchanged" >* Each and every release must be [SIGNED|http://www.apache.org/dev/release-signing.html]
<br>* Your public key should also be cross-signed by other Apache committers (not required,
but suggested) <br></td></tr>
            <tr><td class="diff-snipped" >...<br></td></tr>
        </table>
</div>                            <h4>Full Content</h4>
                    <div class="notificationGreySide">
        <h1><a name="ReleaseGuide-HowtocreateandannounceaKarafrelease."></a>How
to create and announce a Karaf release.</h1>

<h3><a name="ReleaseGuide-Requiredtools%2Cpracticesandresources"></a>Required
tools, practices and resources</h3>

<ul>
	<li>Use Maven 2.0.11 or greater.</li>
	<li>JDK 1.5 (We try to maintain compatibility)</li>
	<li>Install <a href="http://www.princexml.com/" class="external-link" rel="nofollow">princexml</a>
7.1 for manual generation.</li>
	<li>Each and every release must be <a href="http://www.apache.org/dev/release-signing.html"
class="external-link" rel="nofollow">SIGNED</a></li>
	<li>Your public key should also be cross-signed by other Apache committers (not required,
but suggested)</li>
	<li>Make sure you have all Apache servers defined in your <a href="http://maven.apache.org/developers/committer-settings.html"
class="external-link" rel="nofollow">settings.xml</a></li>
</ul>


<h3><a name="ReleaseGuide-Prepare"></a>Prepare</h3>

<p>To prepare and perform a release you must be at least at Apache Karaf Committer.</p>

<p>Your settings.xml should look like:</p>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
&lt;settings&gt;
  ...
  &lt;profiles&gt;
    &lt;profile&gt;
      &lt;id&gt;release&lt;/id&gt;
      &lt;properties&gt;
        &lt;gpg.passphrase&gt; &lt;!-- YOUR KEY PASSPHRASE --&gt; &lt;/gpg.passphrase&gt;
      &lt;/properties&gt;
    &lt;/profile&gt;
  &lt;/profiles&gt;
  ...
  &lt;servers&gt;
    &lt;!-- To publish a snapshot of some part of Maven --&gt;
    &lt;server&gt;
      &lt;id&gt;apache.snapshots.https&lt;/id&gt;
      &lt;username&gt; &lt;!-- YOUR APACHE SVN USERNAME --&gt; &lt;/username&gt;
      &lt;password&gt; &lt;!-- YOUR APACHE SVN PASSWORD --&gt; &lt;/password&gt;
    &lt;/server&gt;
    &lt;!-- To stage a release of some part of Maven --&gt;
    &lt;server&gt;
      &lt;id&gt;apache.releases.https&lt;/id&gt;
      &lt;username&gt; &lt;!-- YOUR APACHE SVN USERNAME --&gt; &lt;/username&gt;
      &lt;password&gt; &lt;!-- YOUR APACHE SVN PASSWORD --&gt; &lt;/password&gt;
    &lt;/server&gt;
    ...
  &lt;/servers&gt;
&lt;/settings&gt;
</pre>
</div></div>

<h3><a name="ReleaseGuide-StagingtheReleaseCandidate"></a>Staging the Release
Candidate</h3>

<ol>
	<li>Grab the latest source
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
svn co https:<span class="code-comment">//svn.apache.org/repos/asf/karaf/trunk</span>
</pre>
</div></div></li>
	<li>Prepare your POMs for release:
	<ol>
		<li>make sure there is no snapshots in the POMs to be released</li>
		<li>make sure everything builds fine</li>
		<li>check that your POMs will not lose content when they are rewritten during the
release process:
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
mvn release:prepare -DdryRun
</pre>
</div></div>
<p>Please diff the original pom.xml with the one named pom.xml.tag to see if the license
or any other info has been removed. This has been known to happen if the starting &lt;project&gt;
tag is not a single line. The only things that should be different between these files are
the &lt;version&gt; and &lt;scm&gt; elements. If there are any other changes,
you must fix the original pom.xml file and commit before proceeding with the release.</p></li>
		<li>publish a snapshot
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
$ mvn deploy
...
[INFO] [deploy:deploy]
[INFO] Retrieving previous build number from apache.snapshots.https
...
</pre>
</div></div></li>
	</ol>
	<ul>
		<li>If you experience an error during deployment like a HTTP 401 check your settings
for the required server entries as outlined in the Prerequisites</li>
		<li>Be sure that the generated artifacts respect the Apache release rules: NOTICE
and LICENSE files should be present in the META-INF directory within the jar. For sources
artifacts, be sure that your POM does not use the maven-source-plugin:2.0.3 which is broken.
The recommended version at this time is 2.0.4</li>
		<li>You should verify the deployment under the snapshot repository on Apache</li>
	</ul>
	</li>
	<li>Prepare the release
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
mvn release:clean
mvn release:prepare
</pre>
</div></div></li>
	<li>Stage the release for a vote
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
mvn release:perform
</pre>
</div></div>
	<ul>
		<li>The release will automatically be inserted into a temporary staging repository
for you, see the <a href="http://www.sonatype.com/books/nexus-book/reference/staging.html"
class="external-link" rel="nofollow">Nexus staging</a> documentation for full details</li>
		<li>You can continue to use mvn release:prepare and mvn release:perform on other sub-projects
as necessary on the same machine and they will be combined in the same staging repository</li>
	</ul>
	</li>
	<li>Close the staging repository
	<ul>
		<li>Login to <a href="https://repository.apache.org" class="external-link" rel="nofollow">https://repository.apache.org</a>
using your Apache SVN credentials. Click on Staging on the left. Then click on org.apache.karaf
in the list of repositories. In the panel below you should see an open repository that is
linked to your username and IP. Right click on this repository and select Close. This will
close the repository from future deployments and make it available for others to view. If
you are staging multiple releases together, skip this step until you have staged everything</li>
	</ul>
	</li>
	<li>Verify the staged artifacts
	<ul>
		<li>If you click on your repository, a tree view will appear below. You can then browse
the contents to ensure the artifacts are as you expect them. Pay particular attention to the
existence of *.asc (signature) files. If you don't like the content of the repository, right
click your repository and choose Drop. You can then rollback your release (see Canceling the
Release) and repeat the process</li>
		<li>Note the staging repository URL (especially the number at the end of the URL)
you will need this in your vote email</li>
	</ul>
	</li>
</ol>



<h3><a name="ReleaseGuide-Startingthevote"></a>Starting the vote</h3>

<p>Propose a vote on the dev list with the closed issues, the issues left, and the staging
repository - for example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
To: <span class="code-quote">"Karaf Developers List"</span> &lt;dev@karaf.apache.org&gt;
Subject: [VOTE] Release Karaf version X.Y.Z

Hi,

We solved N issues in <span class="code-keyword">this</span> release:
http:<span class="code-comment">//issues.apache.org/jira/...
</span>
There are still some outstanding issues:
http:<span class="code-comment">//issues.apache.org/jira/...
</span>
Staging repository:
https:<span class="code-comment">//repository.apache.org/content/repositories/karaf-staging-[YOUR
REPOSITORY ID]/
</span>
Please vote to approve <span class="code-keyword">this</span> release:

[ ] +1 Approve the release
[ ] -1 Veto the release (please provide specific comments)

This vote will be open <span class="code-keyword">for</span> 72 hours.
</pre>
</div></div>
<ul>
	<li>To get the JIRA release notes link, browse to the Karaf <a href="http://issues.apache.org/jira/browse/KARAF"
class="external-link" rel="nofollow">JIRA</a> page, select Release Notes and choose
the release and format (HTML)</li>
	<li>To get the list of issues left in JIRA, select the Open Issues tab on the main
Karaf page.</li>
</ul>


<h3><a name="ReleaseGuide-WaitfortheResults"></a>Wait for the Results</h3>

<p>From <a href="http://www.apache.org/foundation/voting.html" class="external-link"
rel="nofollow">Votes on Package Releases</a>:</p>

<p>Votes on whether a package is ready to be released follow a format similar to majority
approval - except that the decision is officially determined solely by whether at least three
+1 votes were registered. Releases may not be vetoed. Generally the community will table the
vote to release if anyone identifies serious problems, but in most cases the ultimate decision,
once three or more positive votes have been garnered, lies with the individual serving as
release manager. The specifics of the process may vary from project to project, but the 'minimum
of three +1 votes' rule is universal.</p>

<p>The list of binding voters is available at <a href="http://karaf.apache.org/team.html"
class="external-link" rel="nofollow">http://karaf.apache.org/team.html</a>.</p>

<p>If the vote is successful, post the result to the dev list - for example:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
To: <span class="code-quote">"Karaf Developers List"</span> &lt;dev@karaf.apache.org&gt;
Subject: [RESULT] [VOTE] Release Karaf version X.Y.Z

Hi,

The vote has passed with the following result :

  +1 (binding): &lt;&lt;list of names&gt;&gt;
  +1 (non binding): &lt;&lt;list of names&gt;&gt;

I will copy <span class="code-keyword">this</span> release to the Karaf dist directory
and
promote the artifacts to the central Maven repository.
</pre>
</div></div>
<ul>
	<li>If the vote is unsuccessful, you need to fix the issues and restart the process
- see <b>Canceling the Release</b>.</li>
	<li>If the vote is successful, you need to promote and distribute the release - see
<b>Promoting the Release</b>.</li>
</ul>


<h3><a name="ReleaseGuide-CancelingtheRelease"></a>Canceling the Release</h3>

<p>If the vote fails, or you decide to redo the release:</p>

<ol>
	<li>remove the release tag from Subversion (svn del ...)</li>
	<li>login to <a href="https://repository.apache.org" class="external-link" rel="nofollow">https://repository.apache.org</a>
using your Apache SVN credentials. Click on Staging on the left. Then click on org.apache.karaf
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
Close). Right click on this repository and select Drop.</li>
	<li>rollback the version in the pom.xml and commit any fixes you need to make</li>
</ol>


<h3><a name="ReleaseGuide-PromotingtheRelease"></a>Promoting the Release</h3>

<p>If the vote passes:</p>

<ol>
	<li>copy the released artifacts to the Karaf dist directory (/x1/www/www.apache.org/dist/karaf)
on people.apache.org</li>
	<li>delete the old release from the Karaf dist directory (it's archived)</li>
	<li>login to <a href="https://repository.apache.org" class="external-link" rel="nofollow">https://repository.apache.org</a>
with your Apache SVN credentials. Click on Staging. Find your closed staging repository, right
click on it and choose Promote. Select the Releases repository from the drop-down list and
click Promote.</li>
	<li>next click on Repositories, select the Releases repository and validate that your
artifacts are all there</li>
	<li>update the news section on the website at news</li>
	<li>update the download page on the website at downloads 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>

<h3><a name="ReleaseGuide-UpdateJIRA"></a>Update JIRA</h3>

<p>Go to Admin section on the Karaf JIRA and mark the X.Y.Z version as released - create
version X.Y.Z+1, if that hasn't already been done.</p>

<h3><a name="ReleaseGuide-AnnouncingtheKarafRelease"></a>Announcing the
Karaf Release</h3>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
To: <span class="code-quote">"Karaf Developers List"</span> &lt;dev@karaf.apache.org&gt;
Subject: [ANN] Karaf version X.Y.Z Released

The Karaf team is pleased to announce the release of Karaf version X.Y.Z

&lt;&lt;insert <span class="code-object">short</span> description of important
updates&gt;&gt;

  http:<span class="code-comment">//karaf.apache.org/
</span>
This release is available from http:<span class="code-comment">//karaf.apache.org/downloads
and Maven:
</span>
  &lt;dependency&gt;
    &lt;groupId&gt;org.apache.karaf&lt;/groupId&gt;
    &lt;artifactId&gt;org.apache.karaf.XXX&lt;/artifactId&gt;
    &lt;version&gt;X.Y.Z&lt;/version&gt;
  &lt;/dependency&gt;

Release Notes:

&lt;&lt;insert release notes in text format from JIRA&gt;&gt;

Enjoy!

-The Karaf team
</pre>
</div></div>

<p>Remember to forward this announcement to users@karaf.apache.org - try not to cross-post
(CC announcements to both user and dev lists.</p>
    </div>
        <div id="commentsSection" class="wiki-content pageSection">
        <div style="float: right;">
            <a href="https://cwiki.apache.org/confluence/users/viewnotifications.action"
class="grey">Change Notification Preferences</a>
        </div>
        <a href="https://cwiki.apache.org/confluence/display/KARAF/Release+Guide">View
Online</a>
        |
        <a href="https://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=22872260&revisedVersion=8&originalVersion=7">View
Changes</a>
                |
        <a href="https://cwiki.apache.org/confluence/display/KARAF/Release+Guide?showComments=true&amp;showCommentArea=true#addcomment">Add
Comment</a>
            </div>
</div>
</div>
</div>
</div>
</body>
</html>

Mime
View raw message