camel-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From conflue...@apache.org
Subject [CONF] Apache Camel > Release Guide
Date Fri, 06 Jan 2012 21:34:00 GMT
<html>
<head>
    <base href="https://cwiki.apache.org/confluence">
            <link rel="stylesheet" href="/confluence/s/2042/9/1/_/styles/combined.css?spaceKey=CAMEL&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/CAMEL/Release+Guide">Release
Guide</a></h2>
    <h4>Page <b>edited</b> by             <a href="https://cwiki.apache.org/confluence/display/~muellerc">Christian
Mueller</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" >** from Camel 2.10 onwards we will
require to use Maven 3.0.x+ <br>* you may want to get familiar with the release settings
in the parent apache POM. <br></td></tr>
            <tr><td class="diff-added-lines" style="background-color: #dfd;">*
make sure you have installed [princexml|http://www.princexml.com/] to be able to generate
the Camel manual <br>** Add the bin directory to your path variable <br>{code}
<br>PATH=$PATH:/usr/local/lib/prince/bin <br>{code} <br></td></tr>
            <tr><td class="diff-unchanged" > <br>h2. Maven 2 Setup <br></td></tr>
            <tr><td class="diff-snipped" >...<br></td></tr>
    
            </table>
    </div>                            <h4>Full Content</h4>
                    <div class="notificationGreySide">
        <h1><a name="ReleaseGuide-HowtocreateandannounceaCamelrelease."></a>How
to create and announce a Camel release.</h1>

<p>This release guide is based on the <a href="http://maven.apache.org/developers/release/apache-release.html"
class="external-link" rel="nofollow">General guide for releasing Maven-based projects at
Apache</a>, so be sure to check it out before continuing and meet all prerequisites.
</p>

<p><b>Note</b>: Make sure that you are using <b>JDK 6</b>.</p>

<h2><a name="ReleaseGuide-Prerequisites"></a>Prerequisites</h2>

<p>To prepare or perform a release you MUST BE at least an Apache Camel committer.</p>
<ul>
	<li>artifacts for each and every release must be SIGNED; your public key should be
added to the KEYS file</li>
	<li>your public key must also be cross-signed by other Apache committers (this can
be done at key signing parties at ApacheCon for instance)</li>
	<li>make sure you have the correct maven configuration in <tt>~/.m2/settings.xml</tt></li>
	<li>use Maven 2.2.1+ (Maven 2.1.x is known to produce wrong gpg pom signatures - <a
href="http://jira.codehaus.org/browse/MGPG-14" class="external-link" rel="nofollow">MGPG-14</a>)
	<ul>
		<li>from Camel 2.10 onwards we will require to use Maven 3.0.x+</li>
	</ul>
	</li>
	<li>you may want to get familiar with the release settings in the parent apache POM.</li>
	<li>make sure you have installed <a href="http://www.princexml.com/" class="external-link"
rel="nofollow">princexml</a> to be able to generate the Camel manual
	<ul>
		<li>Add the bin directory to your path variable
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
PATH=$PATH:/usr/local/lib/prince/bin
</pre>
</div></div></li>
	</ul>
	</li>
</ul>


<h2><a name="ReleaseGuide-Maven2Setup"></a>Maven 2 Setup</h2>

<p>Before you deploy anything to the maven repository using Maven 2, you should configure
your &#126;/.m2/settings.xml file so that the file permissions of the deployed artifacts
are group writable.  If you do not do this, other developers will not able to overwrite your
SNAPSHOT releases with newer versions. The settings follow the <a href="http://maven.apache.org/developers/committer-settings.html"
class="external-link" rel="nofollow">guidelines </a> used by the Maven project. Please
pay particular attention to the <a href="http://maven.apache.org/guides/mini/guide-encryption.html"
class="external-link" rel="nofollow">password encryption recommendations</a>.</p>

<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-xml">
<span class="code-tag">&lt;settings&gt;</span>
  ...
  <span class="code-tag">&lt;servers&gt;</span>
    <span class="code-tag"><span class="code-comment">&lt;!-- Per http://maven.apache.org/developers/committer-settings.html
--&gt;</span></span>

    <span class="code-tag"><span class="code-comment">&lt;!-- To publish a
snapshot of some part of Maven --&gt;</span></span>
    <span class="code-tag">&lt;server&gt;</span>
      <span class="code-tag">&lt;id&gt;</span>apache.snapshots.https<span
class="code-tag">&lt;/id&gt;</span>
      <span class="code-tag">&lt;username&gt;</span> <span class="code-tag"><span
class="code-comment">&lt;!-- YOUR APACHE LDAP USERNAME --&gt;</span></span>
<span class="code-tag">&lt;/username&gt;</span>
      <span class="code-tag">&lt;password&gt;</span> <span class="code-tag"><span
class="code-comment">&lt;!-- YOUR APACHE LDAP PASSWORD --&gt;</span></span>
<span class="code-tag">&lt;/password&gt;</span>
    <span class="code-tag">&lt;/server&gt;</span>
    <span class="code-tag"><span class="code-comment">&lt;!-- To publish a
website of some part of Maven --&gt;</span></span>
    <span class="code-tag">&lt;server&gt;</span>
      <span class="code-tag">&lt;id&gt;</span>apache.website<span class="code-tag">&lt;/id&gt;</span>
      <span class="code-tag">&lt;username&gt;</span> <span class="code-tag"><span
class="code-comment">&lt;!-- YOUR APACHE LDAP USERNAME --&gt;</span></span>
<span class="code-tag">&lt;/username&gt;</span>
      <span class="code-tag">&lt;filePermissions&gt;</span>664<span
class="code-tag">&lt;/filePermissions&gt;</span>
      <span class="code-tag">&lt;directoryPermissions&gt;</span>775<span
class="code-tag">&lt;/directoryPermissions&gt;</span>
    <span class="code-tag">&lt;/server&gt;</span>
    <span class="code-tag"><span class="code-comment">&lt;!-- To stage a release
of some part of Maven --&gt;</span></span>
    <span class="code-tag">&lt;server&gt;</span>
      <span class="code-tag">&lt;id&gt;</span>apache.releases.https<span
class="code-tag">&lt;/id&gt;</span>
      <span class="code-tag">&lt;username&gt;</span> <span class="code-tag"><span
class="code-comment">&lt;!-- YOUR APACHE LDAP USERNAME --&gt;</span></span>
<span class="code-tag">&lt;/username&gt;</span>
      <span class="code-tag">&lt;password&gt;</span> <span class="code-tag"><span
class="code-comment">&lt;!-- YOUR APACHE LDAP PASSWORD --&gt;</span></span>
<span class="code-tag">&lt;/password&gt;</span>
    <span class="code-tag">&lt;/server&gt;</span>
    <span class="code-tag"><span class="code-comment">&lt;!-- To stage a website
of some part of Maven --&gt;</span></span>
    <span class="code-tag">&lt;server&gt;</span>
      <span class="code-tag">&lt;id&gt;</span>stagingSite<span class="code-tag">&lt;/id&gt;</span>
<span class="code-tag"><span class="code-comment">&lt;!-- must match hard-coded
repository identifier in site:stage-deploy --&gt;</span></span>
      <span class="code-tag">&lt;username&gt;</span> <span class="code-tag"><span
class="code-comment">&lt;!-- YOUR APACHE LDAP USERNAME --&gt;</span></span>
<span class="code-tag">&lt;/username&gt;</span>
      <span class="code-tag">&lt;filePermissions&gt;</span>664<span
class="code-tag">&lt;/filePermissions&gt;</span>
      <span class="code-tag">&lt;directoryPermissions&gt;</span>775<span
class="code-tag">&lt;/directoryPermissions&gt;</span>
    <span class="code-tag">&lt;/server&gt;</span>

  <span class="code-tag">&lt;/servers&gt;</span>
  ...
  <span class="code-tag">&lt;profiles&gt;</span>
    <span class="code-tag">&lt;profile&gt;</span>
      <span class="code-tag">&lt;id&gt;</span>apache-release<span class="code-tag">&lt;/id&gt;</span>
      <span class="code-tag">&lt;properties&gt;</span>
        <span class="code-tag">&lt;gpg.useagent&gt;</span>false<span
class="code-tag">&lt;/gpg.useagent&gt;</span>
        <span class="code-tag">&lt;gpg.passphrase&gt;</span><span class="code-tag"><span
class="code-comment">&lt;!-- YOUR GPG PASSPHRASE --&gt;</span></span><span
class="code-tag">&lt;/gpg.passphrase&gt;</span>
      <span class="code-tag">&lt;/properties&gt;</span>
    <span class="code-tag">&lt;/profile&gt;</span>

  <span class="code-tag">&lt;profiles&gt;</span>
...
<span class="code-tag">&lt;/settings&gt;</span>
</pre>
</div></div>

<p>It is also essential that you configure your umask to 2 on people.apache.org for
non-interactive login.  You can do that by including the snipped below in your <tt>.profile</tt>.</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
umask 002
</pre>
</div></div>


<h3><a name="ReleaseGuide-CreatingtheCamelRelease"></a>Creating the Camel
Release</h3>

<p>The release plugin will prompt for a release version, tag and next release version.
Use a three digit release version of the form: 2.x.x and for the tag use a string of the form:
camel-2.x.x. The next version string should use the two digit from: 2.x-SNAPSHOT as this can
be consistent for future SNAPSHOT releases.</p>

<ol>
	<li>Grab the latest source from SVN
<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/camel/trunk camel
</span>cd camel
</pre>
</div></div></li>
	<li>Verify headers with <a href="http://incubator.apache.org/rat/apache-rat-plugin/usage.html"
class="external-link" rel="nofollow">rat</a>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
mvn -e apache-rat:check
grep -e ' !?????' target/rat.txt -- will show any files without licenses
</pre>
</div></div></li>
	<li>Do a release dry run to check for problems
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
mvn release:prepare -DdryRun=<span class="code-keyword">true</span>
</pre>
</div></div>
<p>Check that you are happy with the results. The poms for the proposed tags will be
in pom.xml.tag. When you like the results, clean up:</p>
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
mvn release:clean
</pre>
</div></div></li>
	<li>Prepare the release
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
mvn release:prepare
</pre>
</div></div>
<p>This will create the tag in svn and leave various stuff around locally to direct
the perform phase.</p></li>
	<li>Perform the release to the staging repo
<div class="code panel" style="border-width: 1px;"><div class="codeContent panelContent">
<pre class="code-java">
mvn release:perform
</pre>
</div></div></li>
	<li>Close the staging repository<br/>
Quote from the <a href="http://maven.apache.org/developers/release/apache-release.html"
class="external-link" rel="nofollow">Maven release guide for Apache projects</a>
<blockquote><p> Login to <a href="https://repository.apache.org" class="external-link"
rel="nofollow">https://repository.apache.org</a> using your Apache LDAP credentials.
Click on "Staging". Then click on "camel" 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. Enter the name and version of the artifact being
released in the "Description" field and then click "Close". This will make it easier to identify
it later.</p></blockquote>
<p>See the image in the original guide for more info.</p></li>
	<li>Verify staged artifacts<br/>
Quote from the <a href="http://maven.apache.org/developers/release/apache-release.html"
class="external-link" rel="nofollow">original guide</a>
<blockquote>
<p>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 the you don't like the content of the repository,
right click your repository and choose "Drop". You can then rollback your release and repeat
the process.<br/>
Note the repository URL, you will need this in your vote email.</p></blockquote></li>
</ol>


<h2><a name="ReleaseGuide-TestingtheCamelReleaseCandidate"></a>Testing the
Camel Release Candidate</h2>

<p>When folks need to test out a release candidate, the jars will not have been uploaded
to the central Maven repo. This means that the example programs which use Maven will not automatically
work and you need to follow the <a href="/confluence/display/CAMEL/Testing+a+release+candidate"
title="Testing a release candidate">Testing a release candidate</a> guidelines.</p>

<h2><a name="ReleaseGuide-Manuallyupdatingfiles"></a>Manually updating files</h2>

<p>The <tt>pom.xml</tt> files in <tt>etc</tt> and <tt>tests/camel-itest-karaf</tt>
need to be manually updated with the Camel version number in the <tt>&lt;parent&gt;</tt>
tag.</p>

<h2><a name="ReleaseGuide-AnnouncingtheCamelRelease"></a>Announcing the
Camel Release</h2>

<ol>
	<li>Perform a <a href="https://issues.apache.org/jira/secure/project/ManageVersions.jspa?pid=12311211"
class="external-link" rel="nofollow">release in JIRA</a> and create a new release
version in JIRA</li>
	<li>There should be already a release notes page in the <a href="/confluence/display/CAMEL/In+Progress"
title="In Progress">In Progress</a> folder (if not create one based on the <a
href="/confluence/display/CAMEL/Camel+x.y.z+Release+%28template%29" title="Camel x.y.z Release
(template)">Camel x.y.z Release &#40;template&#41;</a>). Edit it and change
the number of fixed issues and update its parent to be the <a href="/confluence/display/CAMEL/Download"
title="Download">Download</a> page. Now would be a good time to create a new release
notes page for the next release based on the template mentioned before. It is useful and simpler
to keep it up to date during the development cycle.</li>
	<li>Update the <a href="/confluence/display/CAMEL/Download" title="Download">Download</a>
page to refer to the latest release distributions (search &amp; replace the version numbers
mostly)</li>
	<li>Update the <a href="/confluence/display/CAMEL/Xml+Reference" title="Xml Reference">Xml
Reference</a> page with a link to the HTML and XSD</li>
	<li>Copy the newly deployed camel-spring-X.Y.Z.xsd file to camel-spring.xsd here <a
href="http://camel.apache.org/schema/spring/" class="external-link" rel="nofollow">http://camel.apache.org/schema/spring/</a>
by ssh into people.apache.org.</li>
	<li>Copy the newly deployed camel-spring-integration-X.Y.Z.xsd file to camel-spring-integration.xsd
here <a href="http://camel.apache.org/schema/spring/integration" class="external-link"
rel="nofollow">http://camel.apache.org/schema/spring/integration</a> by ssh into
people.apache.org.</li>
	<li>Copy the newly deployed camel-blueprint-X.Y.Z.xsd file to camel-blueprint.xsd here
<a href="http://camel.apache.org/schema/blueprint/" class="external-link" rel="nofollow">http://camel.apache.org/schema/blueprint/</a>
by ssh into people.apache.org.</li>
	<li>Copy the newly deployed camel-cxf-X.Y.Z-spring.xsd file to camel-cxf.xsd here <a
href="http://camel.apache.org/schema/cxf/" class="external-link" rel="nofollow">http://camel.apache.org/schema/cxf/</a>
by ssh into people.apache.org.</li>
	<li>Copy the newly deployed camel-cxf-X.Y.Z-blueprint.xsd file to camel-cxf.xsd here
<a href="http://camel.apache.org/schema/blueprint/cxf/" class="external-link" rel="nofollow">http://camel.apache.org/schema/blueprint/cxf/</a>
by ssh into people.apache.org.</li>
	<li>Copy the newly deployed camel-cxf-X.Y.Z.xsd file to camel-cxf.xsd here <a href="http://camel.apache.org/schema/blueprint/cxf/"
class="external-link" rel="nofollow">http://camel.apache.org/schema/blueprint/cxf/</a>
by ssh into people.apache.org.</li>
	<li>Copy the newly deployed camel-spring-security-X.Y.Z.xsd file to camel-spring-security.xsd
here <a href="http://camel.apache.org/schema/spring-security/" class="external-link" rel="nofollow">http://camel.apache.org/schema/spring-security/</a>
by ssh into people.apache.org.</li>
	<li>Update the <a href="/confluence/display/CAMEL/Manual" title="Manual">Manual</a>
page with a link to the PDF</li>
	<li>Mail the <a href="mailto:dev@camel.apache.org" class="external-link" rel="nofollow">dev</a>
&amp; <a href="mailto:user@camel.apache.org" class="external-link" rel="nofollow">user</a>
lists</li>
	<li><a href="https://cwiki.apache.org/confluence/pages/createblogpost.action?spaceKey=CAMEL"
class="external-link" rel="nofollow">Post</a> a news entry in the wiki which <b>links
to the release page</b> so folks can download it!</li>
	<li>perform a full <a href="http://cwiki.apache.org/confluence/admin/plugins.action?pluginKey=confluence.extra.autoexport"
class="external-link" rel="nofollow">auto-export plugin export of the wiki</a> to
static html to work around the bug with autoexport plugin not updating the <a href="http://cwiki.apache.org/CAMEL/index.html"
class="external-link" rel="nofollow">index page when you post the news item</a><br/>
  to run autoexport: you go to admin -&gt; plugins -&gt; auto-export-plugin -&gt;
configure plugin. Select ActiveMQ from the list, then click on Export Space(s). Be very careful
so you don't mess up anyone else's wikis!</li>
	<li>Add the release version number to the following <tt>spring.schemas</tt>
file located in <tt>src/main/resources/META-INF</tt> directory of the following
components:<br/>
  camel-cxf<br/>
  camel-spring<br/>
  camel-spring-integration<br/>
  camel-spring-security</li>
	<li>Have a beer&#33; <img class="emoticon" src="/confluence/images/icons/emoticons/smile.gif"
height="20" width="20" align="absmiddle" alt="" border="0"/></li>
</ol>


    </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/CAMEL/Release+Guide">View
Online</a>
        |
        <a href="https://cwiki.apache.org/confluence/pages/diffpagesbyversion.action?pageId=68287&revisedVersion=51&originalVersion=50">View
Changes</a>
                |
        <a href="https://cwiki.apache.org/confluence/display/CAMEL/Release+Guide?showComments=true&amp;showCommentArea=true#addcomment">Add
Comment</a>
            </div>
</div>
</div>
</div>
</div>
</body>
</html>

Mime
View raw message