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 Tue, 13 Jul 2010 13:03: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 (8)</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" >... <br>{code} <br></td></tr>
            <tr><td class="diff-changed-lines" ><span class="diff-added-words"style="background-color:
#dfd;">**</span> If you experience an error during deployment like a HTTP 401 check
your settings for the required server entries as outlined in the Prerequisites <br></td></tr>
            <tr><td class="diff-changed-lines" ><span class="diff-added-words"style="background-color:
#dfd;">**</span> 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 <br></td></tr>
            <tr><td class="diff-changed-lines" ><span class="diff-added-words"style="background-color:
#dfd;">**</span> You should verify the deployment under the snapshot repository on
Apache <br></td></tr>
            <tr><td class="diff-unchanged" ># Prepare the release <br>{code}
<br></td></tr>
            <tr><td class="diff-snipped" >...<br></td></tr>
            <tr><td class="diff-unchanged" >mvn release:perform <br>{code}
<br></td></tr>
            <tr><td class="diff-changed-lines" ><span class="diff-added-words"style="background-color:
#dfd;">**</span> The release will automatically be inserted into a temporary staging
repository for you, see the [Nexus staging|http://www.sonatype.com/books/nexus-book/reference/staging.html]
documentation for full details <br></td></tr>
            <tr><td class="diff-changed-lines" ><span class="diff-added-words"style="background-color:
#dfd;">**</span> 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 <br></td></tr>
            <tr><td class="diff-unchanged" ># Close the staging repository <br></td></tr>
            <tr><td class="diff-changed-lines" ><span class="diff-added-words"style="background-color:
#dfd;">**</span> Login to https://repository.apache.org 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 <br></td></tr>
            <tr><td class="diff-unchanged" ># Verify the staged artifacts  <br></td></tr>
            <tr><td class="diff-changed-lines" ><span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">*</span>
<span class="diff-added-words"style="background-color: #dfd;">**</span> 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&#39;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 <br></td></tr>
            <tr><td class="diff-changed-lines" ><span class="diff-deleted-words"style="color:#999;background-color:#fdd;text-decoration:line-through;">*</span>
<span class="diff-added-words"style="background-color: #dfd;">**</span> Note the
staging repository URL (especially the number at the end of the URL) you will need this in
your vote email <br></td></tr>
            <tr><td class="diff-unchanged" > <br> <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>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">
TODO
</pre>
</div></div>

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

<p>TODO</p>

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

<p>TODO</p>

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

<p>TODO</p>

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

<p>TODO</p>

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

<p>TODO</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=4&originalVersion=3">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