| <!DOCTYPE html>
|
|
|
| <html lang="en">
|
| <head>
|
| <title>Developer Guide — Apache MINA</title>
|
|
|
| <link href="/assets/css/common.css" rel="stylesheet" type="text/css"/>
|
| <link href="/assets/css/mina.css" rel="stylesheet" type="text/css"/>
|
| </head>
|
| <body>
|
| <script src="https://www.apachecon.com/event-images/snippet.js"></script>
|
| <div id="container">
|
| <div id="header">
|
| <div id="subProjectsNavBar">
|
| <a href="/">
|
|
|
| Apache MINA Project
|
|
|
| </a>
|
| |
|
| <a href="/mina-project/">
|
|
|
| <strong>MINA</strong>
|
|
|
| </a>
|
| |
|
| <a href="/asyncweb-project/">
|
|
|
| AsyncWeb
|
|
|
| </a>
|
| |
|
| <a href="/ftpserver-project/">
|
|
|
| FtpServer
|
|
|
| </a>
|
| |
|
| <a href="/sshd-project/">
|
|
|
| SSHD
|
|
|
| </a>
|
| |
|
| <a href="/vysper-project/">
|
|
|
| Vysper
|
|
|
| </a>
|
| </div>
|
| </div>
|
|
|
|
|
| <div id="content">
|
| <div id="leftColumn">
|
| <div id="navigation">
|
| <a class="acevent" data-format="wide" data-width="170"></a>
|
| <h5>Social Networks</h5>
|
| <ul>
|
| <li><a href="https://fosstodon.org/@apachemina">Apache MINA Mastodon</a></li>
|
| </ul>
|
| <h5>Latest Downloads</h5>
|
| <ul>
|
| <li><a href="/mina-project/downloads_2_0.html">Mina 2.0.25</a></li>
|
| <li><a href="/mina-project/downloads_2_1.html">Mina 2.1.8</a></li>
|
| <li><a href="/mina-project/downloads_2_2.html">Mina 2.2.3</a></li>
|
| <li><a href="/mina-project/downloads_old.html">Mina old versions</a></li>
|
| </ul>
|
| <h5>Documentation</h5>
|
| <ul>
|
| <li><a href="/mina-project/documentation.html" class="external-link" rel="nofollow">Base documentation</a></li>
|
| <li><a href="/mina-project/userguide/user-guide-toc.html" class="external-link" rel="nofollow">User guide</a></li>
|
| <li><a href="/mina-project/2.2-vs-2.1.html" class="external-link" rel="nofollow">2.2 vs 2.1</a></li>
|
| <li><a href="/mina-project/2.1-vs-2.0.html" class="external-link" rel="nofollow">2.1 vs 2.0</a></li>
|
| <li><a href="/mina-project/features.html" class="external-link" rel="nofollow">Features</a></li>
|
| <li><a href="/mina-project/road-map.html" class="external-link" rel="nofollow">Road Map</a></li>
|
| <li><a href="/mina-project/quick-start-guide.html" class="external-link" rel="nofollow">Quick Start Guide</a></li>
|
| <li><a href="/mina-project/faq.html" class="external-link" rel="nofollow">FAQ</a></li>
|
| </ul>
|
| <h5>Resources</h5>
|
| <ul>
|
| <li><a href="/mina-project/mailing-lists.html" class="external-link" rel="nofollow">Mailing lists & IRC</a></li>
|
| <li><a href="/mina-project/issue-tracking.html" class="external-link" rel="nofollow">Issue tracking</a></li>
|
| <li><a href="/mina-project/sources.html" class="external-link" rel="nofollow">Sources</a></li>
|
| <li><a href="/mina-project/gen-docs/latest-2.0/apidocs/index.html" class="external-link" rel="nofollow">API Javadoc 2.0.25</a></li>
|
| <li><a href="/mina-project/gen-docs/latest-2.1/apidocs/index.html" class="external-link" rel="nofollow">API Javadoc 2.1.8</a></li>
|
| <li><a href="/mina-project/gen-docs/latest-2.2/apidocs/index.html" class="external-link" rel="nofollow">API Javadoc 2.2.3</a></li>
|
| <li><a href="/mina-project/gen-docs/latest-2.0/xref/index.html" class="external-link" rel="nofollow">API xref 2.0.25</a></li>
|
| <li><a href="/mina-project/gen-docs/latest-2.1/xref/index.html" class="external-link" rel="nofollow">API xref 2.1.8</a></li>
|
| <li><a href="/mina-project/gen-docs/latest-2.2/xref/index.html" class="external-link" rel="nofollow">API xref 2.2.3</a></li>
|
| <li><a href="/mina-project/performances.html" class="external-link" rel="nofollow">Performances</a></li>
|
| <li><a href="/mina-project/testimonials.html" class="external-link" rel="nofollow">Testimonials</a></li>
|
| <li><a href="/mina-project/conferences.html" class="external-link" rel="nofollow">Conferences</a></li>
|
| <li><a href="/mina-project/developer-guide.html" class="external-link" rel="nofollow">Developers Guide</a></li>
|
| <li><a href="/mina-project/related-projects.html" class="external-link" rel="nofollow">Related Projects</a></li>
|
| <li><a href="https://people.apache.org/~vgritsenko/stats/projects/mina.html" class="external-link" rel="nofollow">Statistics</a></li>
|
| </ul>
|
|
|
| <h5>Community</h5>
|
| <ul>
|
| <li><a href="https://www.apache.org/foundation/contributing.html" class="external-link" rel="nofollow">Contributing</a></li>
|
| <li><a href="/contributors.html" class="external-link" rel="nofollow">Team</a></li>
|
| <li><a href="/special-thanks.html" class="external-link" rel="nofollow">Special Thanks</a></li>
|
| <li><a href="https://www.apache.org/security/" class="external-link" rel="nofollow">Security</a></li>
|
| </ul>
|
|
|
| <h5>About Apache</h5>
|
| <ul>
|
| <li><a href="https://www.apache.org" class="external-link" rel="nofollow">Apache main site</a></li>
|
| <li><a href="https://www.apache.org/licenses/" class="external-link" rel="nofollow">License</a></li>
|
| <li><a href="https://www.apache.org/foundation/sponsorship.html" title="The ASF sponsorship program" class="external-link" rel="nofollow">Sponsorship program</a></li>
|
| <li><a href="https://www.apache.org/foundation/thanks.html" class="external-link" rel="nofollow">Thanks</a></li>
|
| </ul>
|
|
|
| <h3><a name="Navigation-Upcoming"></a>Upcoming</h3>
|
| <ul>
|
| <li>No event</li>
|
| </ul>
|
| </div>
|
| </div>
|
| <div id="rightColumn">
|
|
|
|
|
| |
| <h1 id="building-mina">Building MINA</h1> |
| <div class="note" markdown="1"> |
| Please read <a href="https://www.apache.org/dev/" class="external-link" rel="nofollow">the Developer Infrastructure Information</a> if you haven't yet before you proceed. |
| </div> |
| <nav id="TableOfContents"> |
| <ul> |
| <li><a href="#preparing-the-release-for-the-vote">Preparing the release for the vote</a> |
| <ul> |
| <li><a href="#step-0-building-mina">Step 0: Building MINA</a></li> |
| <li><a href="#step-1-tagging-and-deploying">Step 1: Tagging and Deploying</a></li> |
| <li><a href="#step-2--processing-with-a-dry-run">step 2 : Processing with a dry run</a></li> |
| <li><a href="#step-3--processing-with-the-real-release">Step 3 : Processing with the real release</a></li> |
| <li><a href="#step-4--perform-the-release">Step 4 : perform the release</a></li> |
| <li><a href="#step-5--closing-the-staging-release-on-nexus">Step 5 : closing the staging release on nexus</a></li> |
| <li><a href="#step-6--build-the-site">Step 6 : Build the Site</a></li> |
| <li><a href="#step-7--sign-the-packages">Step 7 : Sign the packages</a></li> |
| <li><a href="#step-8--publish-source-and-binary-distribution-packages">Step 8 : Publish Source and Binary Distribution Packages</a></li> |
| <li><a href="#step-9--test-the-new-version-with-ftpserver-sshd-and-vysper">Step 9 : Test the New Version with FtpServer, Sshd and Vysper</a></li> |
| </ul> |
| </li> |
| <li><a href="#step-10--voting-a-release">Step 10 : Voting a release</a> |
| <ul> |
| <li><a href="#step-11--close-the-vote">Step 11 : Close the vote</a></li> |
| <li><a href="#step-12-deploy-web-reports-javadoc-and-jxr">Step 12: Deploy Web Reports (JavaDoc and JXR)</a></li> |
| <li><a href="#step-13-wait-24-hours">Step 13: Wait 24 hours</a></li> |
| <li><a href="#step-14-update-the-links-in-web-site">Step 14: Update the Links in Web Site</a></li> |
| <li><a href="#step-15-wait-another-24-hours">Step 15: Wait another 24 hours</a></li> |
| <li><a href="#step-16-announce-the-new-release">Step 16: Announce the New Release</a></li> |
| </ul> |
| </li> |
| </ul> |
| </nav> |
| <h1 id="checking-out-the-code">Checking out the code</h1> |
| <p>You need Git to check out the source code from our source code repository, and [Maven(https://maven.apache.org/) 3.8.5 (pick the latest Maven version) to build the source code (Building with Maven 3.0 will also work). The following example shows how to build the current stable branch (2.0.9).</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ git clone https://gitbox.apache.org/repos/asf/mina.git mina |
| $ <span style="color:#a2f">cd</span> mina |
| $ mvn -Pserial clean install <span style="color:#080;font-style:italic"># Build packages (JARs) for the core API and other</span> |
| <span style="color:#080;font-style:italic"># extensions and install them to the local Maven repository.</span> |
| $ mvn -Pserial site <span style="color:#080;font-style:italic"># Generate reports (JavaDoc and JXR)</span> |
| $ mvn -Pserial package assembly:assembly <span style="color:#080;font-style:italic"># Generate a tarball (package goal needed to fix an assembly plugin bug)</span> |
| $ mvn -Pserial eclipse:eclipse <span style="color:#080;font-style:italic"># Generate Eclipse project files if you want</span> |
| </code></pre></div><p>Eclipse users: |
| Don’t forget to declare a classpath variable named M2_REPO, pointing to <code>~/.m2/repository</code>, otherwise many links to existing jars will be broken. |
| You can declare new variables in Eclipse in Windows -> Preferences… and selecting Java -> Build Path -> Classpath Variables</p> |
| <p>There are also other branches that might interest you:</p> |
| <ul> |
| <li>trunk: Where big changes take place everyday</li> |
| </ul> |
| <p>If you want to check out the source code of previous releases, you have to select the branch you want to work on :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ git clone https://gitbox.apache.org/repos/asf/mina.git mina |
| $ <span style="color:#a2f">cd</span> mina |
| $ git checkout <tag> |
| </code></pre></div><p>For instance, to work on the on-going 2.2.X version trunk, just do :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ git clone https://gitbox.apache.org/repos/asf/mina.git mina |
| $ <span style="color:#a2f">cd</span> mina |
| $ git checkout 2.2.X |
| </code></pre></div><h1 id="coding-convention">Coding Convention</h1> |
| <p>We follow <a href="https://www.oracle.com/technetwork/java/codeconventions-150003.pdf">Sun’s standard Java coding convention</a> except that we always use spaces instead of tabs. Please download <a href="ImprovedJavaConventions.xml">the Eclipse Java formatter settings file</a> before you make any changes to the code.</p> |
| <p>This file is also available in the <code>/resources</code> directory.</p> |
| <h1 id="class-header">Class header</h1> |
| <p>As class header we use :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-java" data-lang="java"><span style="color:#080;font-style:italic">/** |
| </span><span style="color:#080;font-style:italic"> * Class desciption here. |
| </span><span style="color:#080;font-style:italic"> * |
| </span><span style="color:#080;font-style:italic"> * @author <a href="https://mina.apache.org">Apache MINA Project</a> |
| </span><span style="color:#080;font-style:italic"> */</span> |
| </code></pre></div><p>The headers revisions tags are removed.</p> |
| <h1 id="deploying-snapshots-committers-only">Deploying Snapshots (Committers Only)</h1> |
| <p>Before running Maven to deploy artifacts, <em>please make sure if your umask is configured correctly</em>. Unless configured properly, other committers will experience annoying ‘permission denied’ errors. If your default shell is <code>bash</code>, please update your umask setting in the <code>~/.bashrc</code> file (create one if it doesn’t exist.) by adding the following line:</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash"><span style="color:#a2f">umask</span> <span style="color:#666">002</span> |
| </code></pre></div><p>Please note that you have to edit the correct <code>shrc</code> file. If you use <code>csh</code>, then you will have to edit <code>~/.cshrc</code> file.</p> |
| <p>Now you are ready to deploy the artifacts if you configured your umask correctly.</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ git clone https://gitbox.apache.org/repos/asf/mina.git mina |
| $ <span style="color:#a2f">cd</span> mina |
| $ mvn -Pserial clean deploy site site:deploy <span style="color:#080;font-style:italic"># Make sure to run 'clean' goal first to prevent side effects from your IDE.</span> |
| </code></pre></div><p>Please double-check the mode (i.e. <code>0664</code> or <code>-rw-rw-r--</code>, a.k.a permission code) of the deployed artifacts, otherwise you can waste other people’s time significantly.</p> |
| <h1 id="releasing-a-point-release-committers-only">Releasing a Point Release (Committers Only)</h1> |
| <h2 id="preparing-the-release-for-the-vote">Preparing the release for the vote</h2> |
| <p>Before starting be sure to have the java and mvn command in your PATH. |
| On linux you can check with the following commands (change the Maven version accordingly):</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ <span style="color:#a2f">type</span> mvn |
| mvn is hashed <span style="color:#666">(</span>/opt/maven-3.8.5/bin/mvn<span style="color:#666">)</span> |
| $ <span style="color:#a2f">type</span> java |
| java is hashed <span style="color:#666">(</span>/usr/bin/java<span style="color:#666">)</span> |
| </code></pre></div><h3 id="step-0-building-mina">Step 0: Building MINA</h3> |
| <p>As weird as it sounds, for some unknown reason (most certainly a misconfiguration in the Maven poms), we can’t just run the release without having previously build all the projects. This is done with the following command :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ mvn clean install -Pserial |
| </code></pre></div><h3 id="step-1-tagging-and-deploying">Step 1: Tagging and Deploying</h3> |
| <p>First you need to configure maven for using the good username for scp and operation.</p> |
| <p>In the <code>~/.m2/settings.xml</code> you need the following lines :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-xml" data-lang="xml"><span style="color:#008000;font-weight:bold"><settings</span> <span style="color:#b44">xmlns=</span><span style="color:#b44">"http://maven.apache.org/POM/4.0.0"</span> |
| <span style="color:#b44">xmlns:xsi=</span><span style="color:#b44">"http://www.w3.org/2001/XMLSchema-instance"</span> |
| <span style="color:#b44">xsi:schemaLocation=</span><span style="color:#b44">"http://maven.apache.org/POM/4.0.0 |
| </span><span style="color:#b44"> http://maven.apache.org/xsd/settings-1.0.0.xsd"</span><span style="color:#008000;font-weight:bold">></span> |
| |
| <span style="color:#080;font-style:italic"><!--</span><span style="color:#080;font-style:italic"> SERVER SETTINGS </span><span style="color:#080;font-style:italic">--></span> |
| <span style="color:#008000;font-weight:bold"><servers</span><span style="color:#008000;font-weight:bold">></span> |
| <span style="color:#080;font-style:italic"><!--</span><span style="color:#080;font-style:italic"> To publish a snapshot of some part of Maven </span><span style="color:#080;font-style:italic">--></span> |
| <span style="color:#008000;font-weight:bold"><server</span><span style="color:#008000;font-weight:bold">></span> |
| <span style="color:#008000;font-weight:bold"><id</span><span style="color:#008000;font-weight:bold">></span>apache.snapshots.https<span style="color:#008000;font-weight:bold"></id></span> |
| <span style="color:#008000;font-weight:bold"><username</span><span style="color:#008000;font-weight:bold">></span>elecharny<span style="color:#008000;font-weight:bold"></username></span> |
| <span style="color:#008000;font-weight:bold"><password</span><span style="color:#008000;font-weight:bold">></span>-----Your password here-----<span style="color:#008000;font-weight:bold"></password></span> |
| <span style="color:#008000;font-weight:bold"></server></span> |
| <span style="color:#080;font-style:italic"><!--</span><span style="color:#080;font-style:italic"> To publish a website of some part of Maven </span><span style="color:#080;font-style:italic">--></span> |
| <span style="color:#008000;font-weight:bold"><server</span><span style="color:#008000;font-weight:bold">></span> |
| <span style="color:#008000;font-weight:bold"><id</span><span style="color:#008000;font-weight:bold">></span>apache.websites<span style="color:#008000;font-weight:bold"></id></span> |
| <span style="color:#008000;font-weight:bold"><username</span><span style="color:#008000;font-weight:bold">></span>elecharny<span style="color:#008000;font-weight:bold"></username></span> |
| <span style="color:#008000;font-weight:bold"><filePermissions</span><span style="color:#008000;font-weight:bold">></span>664<span style="color:#008000;font-weight:bold"></filePermissions></span> |
| <span style="color:#008000;font-weight:bold"><directoryPermissions</span><span style="color:#008000;font-weight:bold">></span>775<span style="color:#008000;font-weight:bold"></directoryPermissions></span> |
| <span style="color:#008000;font-weight:bold"></server></span> |
| <span style="color:#080;font-style:italic"><!--</span><span style="color:#080;font-style:italic"> To stage a release of some part of Maven </span><span style="color:#080;font-style:italic">--></span> |
| <span style="color:#008000;font-weight:bold"><server</span><span style="color:#008000;font-weight:bold">></span> |
| <span style="color:#008000;font-weight:bold"><id</span><span style="color:#008000;font-weight:bold">></span>apache.releases.https<span style="color:#008000;font-weight:bold"></id></span> |
| <span style="color:#008000;font-weight:bold"><username</span><span style="color:#008000;font-weight:bold">></span>elecharny<span style="color:#008000;font-weight:bold"></username></span> |
| <span style="color:#008000;font-weight:bold"><password</span><span style="color:#008000;font-weight:bold">></span>-----Your password here-----<span style="color:#008000;font-weight:bold"></password></span> |
| <span style="color:#008000;font-weight:bold"></server></span> |
| <span style="color:#080;font-style:italic"><!--</span><span style="color:#080;font-style:italic"> To stage a website of some part of Maven </span><span style="color:#080;font-style:italic">--></span> |
| <span style="color:#008000;font-weight:bold"><server</span><span style="color:#008000;font-weight:bold">></span> |
| <span style="color:#008000;font-weight:bold"><id</span><span style="color:#008000;font-weight:bold">></span>stagingSite<span style="color:#008000;font-weight:bold"></id></span> <span style="color:#080;font-style:italic"><!--</span><span style="color:#080;font-style:italic"> must match hard</span><span style="color:#080;font-style:italic">-</span><span style="color:#080;font-style:italic">coded repository identifier in site:stage</span><span style="color:#080;font-style:italic">-</span><span style="color:#080;font-style:italic">deploy </span><span style="color:#080;font-style:italic">--></span> |
| <span style="color:#008000;font-weight:bold"><username</span><span style="color:#008000;font-weight:bold">></span>elecharny<span style="color:#008000;font-weight:bold"></username></span> |
| <span style="color:#008000;font-weight:bold"><filePermissions</span><span style="color:#008000;font-weight:bold">></span>664<span style="color:#008000;font-weight:bold"></filePermissions></span> |
| <span style="color:#008000;font-weight:bold"><directoryPermissions</span><span style="color:#008000;font-weight:bold">></span>775<span style="color:#008000;font-weight:bold"></directoryPermissions></span> |
| <span style="color:#008000;font-weight:bold"></server></span> |
| <span style="color:#008000;font-weight:bold"></servers></span> |
| |
| <span style="color:#080;font-style:italic"><!--</span><span style="color:#080;font-style:italic"> PROFILE SETTINGS </span><span style="color:#080;font-style:italic">--></span> |
| <span style="color:#008000;font-weight:bold"><profiles</span><span style="color:#008000;font-weight:bold">></span> |
| <span style="color:#008000;font-weight:bold"><profile</span><span style="color:#008000;font-weight:bold">></span> |
| <span style="color:#008000;font-weight:bold"><id</span><span style="color:#008000;font-weight:bold">></span>apache-release<span style="color:#008000;font-weight:bold"></id></span> |
| <span style="color:#008000;font-weight:bold"><properties</span><span style="color:#008000;font-weight:bold">></span> |
| <span style="color:#080;font-style:italic"><!--</span><span style="color:#080;font-style:italic"> Configuration for artifacts signature </span><span style="color:#080;font-style:italic">--></span> |
| <span style="color:#008000;font-weight:bold"><gpg.passphrase</span><span style="color:#008000;font-weight:bold">></span>-----Your passphrase here-----<span style="color:#008000;font-weight:bold"></gpg.passphrase></span> |
| <span style="color:#008000;font-weight:bold"></properties></span> |
| <span style="color:#008000;font-weight:bold"></profile></span> |
| <span style="color:#008000;font-weight:bold"></profiles></span> |
| |
| <span style="color:#008000;font-weight:bold"></settings></span> |
| </code></pre></div><h3 id="step-2--processing-with-a-dry-run">step 2 : Processing with a dry run</h3> |
| <p>After having checked out the trunk, and built it (see step 0),</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ git clone https://gitbox.apache.org/repos/asf/mina.git mina |
| $ <span style="color:#a2f">cd</span> mina |
| $ mvn clean install -Pserial |
| </code></pre></div><p>run the following commands :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ mvn -Pserial,apache-release -DdryRun<span style="color:#666">=</span><span style="color:#a2f">true</span> release:prepare <span style="color:#080;font-style:italic"># Dry-run first.</span> |
| </code></pre></div><p>Answer to maven questions :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-text" data-lang="text">"What is the release version for "Apache MINA"? (org.apache.mina:mina-parent) <version>: :" |
| <either use the default version as suggested, or type in the version you@qot;d like to be used> |
| [..] |
| </code></pre></div><p>Then some other questions will be asked, about the next version to use. The default values should be fine.</p> |
| <div class="info" markdown="1"> |
| <strong>Be Careful</strong><br> |
| <pre><code>Make sure the change made by the release plugin is correct! (pom.xml, tags created) |
| </code></pre> |
| </div> |
| <div class="info" markdown="1"> |
| <strong>In case of a problem...</strong><br> |
| <pre><code>It's frequent that the dry-run fails, typically when you have some Javadoc issues (with Java 8, the compiler is really picky about wrong HTML tags or missing parameters). |
| |
| You can rollback the release with the command: |
| |
| $ mvn -Pserial,apache-release -DdryRun=true release:rollback |
| |
| You should be back on your feet. |
| </code></pre> |
| </div> |
| <h3 id="step-3--processing-with-the-real-release">Step 3 : Processing with the real release</h3> |
| <p>When the dry run is successful, then you can do in real with the following commands:</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ mvn -Pserial,apache-release release:clean <span style="color:#080;font-style:italic"># Clean up the temporary files created by the dry-run.</span> |
| $ mvn -Pserial,apache-release release:prepare <span style="color:#080;font-style:italic"># Copy to tags directory.</span> |
| </code></pre></div><p>The first step will clean up the local sources, the second step will release for real. The same questions will be asked as those we had during the dry run step.</p> |
| <p>At some point, it will ask for your passphrase (the one you used when you created your PGP key). Type it in.</p> |
| <p>Three mails will be generated, and sent to <a href="mailto:commits@mina.apache.org">commits@mina.apache.org</a> :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-text" data-lang="text">git commit: [maven-release-plugin] prepare release 2.0.9 |
| Git Push Summary |
| git commit: [maven-release-plugin] prepare for next development iteration |
| </code></pre></div><p>The first mail tells you that the SNAPSHOT has been moved to the release version in trunk, the second mails tells you that this version has been tagged, and the last mail tells you that trunk has moved to the next version.</p> |
| <h3 id="step-4--perform-the-release">Step 4 : perform the release</h3> |
| <p>The last step before launching a vote is to push the potential release to Nexus so that every user can test the created packages. Perform the following actions (note that we have to run a build first for the javadoc to be correctly generated…) :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ mvn clean install -Pserial -DskipTests |
| ... |
| $ mvn -Pserial,apache-release release:perform |
| ... |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> ------------------------------------------------------------------------ |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Reactor Summary: |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> ------------------------------------------------------------------------ |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Apache MINA ........................................... SUCCESS <span style="color:#666">[</span>1:05.896s<span style="color:#666">]</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Apache MINA Legal ..................................... SUCCESS <span style="color:#666">[</span>30.708s<span style="color:#666">]</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Apache MINA Core ...................................... SUCCESS <span style="color:#666">[</span>4:44.973s<span style="color:#666">]</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Apache MINA APR Transport ............................. SUCCESS <span style="color:#666">[</span>46.082s<span style="color:#666">]</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Apache MINA Compression Filter ........................ SUCCESS <span style="color:#666">[</span>40.230s<span style="color:#666">]</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Apache MINA State Machine ............................. SUCCESS <span style="color:#666">[</span>52.718s<span style="color:#666">]</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Apache MINA JavaBeans Integration ..................... SUCCESS <span style="color:#666">[</span>46.358s<span style="color:#666">]</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Apache MINA XBean Integration ......................... SUCCESS <span style="color:#666">[</span>1:21.054s<span style="color:#666">]</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Apache MINA OGNL Integration .......................... SUCCESS <span style="color:#666">[</span>40.740s<span style="color:#666">]</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Apache MINA JMX Integration ........................... SUCCESS <span style="color:#666">[</span>40.482s<span style="color:#666">]</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Apache MINA Examples .................................. SUCCESS <span style="color:#666">[</span>1:13.837s<span style="color:#666">]</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Apache MINA Serial Communication support .............. SUCCESS <span style="color:#666">[</span>41.684s<span style="color:#666">]</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Apache MINA Distribution .............................. SUCCESS <span style="color:#666">[</span>12:39.542s<span style="color:#666">]</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> ------------------------------------------------------------------------ |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> ------------------------------------------------------------------------ |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> BUILD SUCCESSFUL |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> ------------------------------------------------------------------------ |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Total time: <span style="color:#666">26</span> minutes <span style="color:#666">46</span> seconds |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Finished at: Mon Sep <span style="color:#666">13</span> 16:45:14 CEST <span style="color:#666">2010</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Final Memory: 98M/299M |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> <span style="color:#666">[</span>INFO<span style="color:#666">]</span> ------------------------------------------------------------------------ |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Cleaning up after release... |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> ------------------------------------------------------------------------ |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> BUILD SUCCESSFUL |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> ------------------------------------------------------------------------ |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Total time: <span style="color:#666">27</span> minutes <span style="color:#666">5</span> seconds |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Finished at: Mon Sep <span style="color:#666">13</span> 16:45:18 CEST <span style="color:#666">2010</span> |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> Final Memory: 28M/81M |
| <span style="color:#666">[</span>INFO<span style="color:#666">]</span> ------------------------------------------------------------------------ |
| </code></pre></div><p>Done !</p> |
| <h3 id="step-5--closing-the-staging-release-on-nexus">Step 5 : closing the staging release on nexus</h3> |
| <p>Now, you have to close the staged project on nexus. In order to do that you <strong>must</strong> have exported your PGP key to a PGP public server <a href="https://www.apache.org/dev/openpgp.html">see</a></p> |
| <p>Connect to the <a href="https://repository.apache.org">Nexus server</a>, login, and select the MINA staging repository you just created, then click on the ‘close’ button. You are home…</p> |
| <h3 id="step-6--build-the-site">Step 6 : Build the Site</h3> |
| <p>You will need to modify the <strong>pom.xml</strong> file to be able to run the <strong>mvn site</strong> command. Actually, you have to comment the executions part of the maven JXF plugin in the <strong>maven-site-plugin</strong> configuration :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-xml" data-lang="xml"><span style="color:#008000;font-weight:bold"><plugin</span><span style="color:#008000;font-weight:bold">></span> |
| <span style="color:#008000;font-weight:bold"><artifactId</span><span style="color:#008000;font-weight:bold">></span>maven-jxr-plugin<span style="color:#008000;font-weight:bold"></artifactId></span> |
| <span style="color:#008000;font-weight:bold"><configuration</span><span style="color:#008000;font-weight:bold">></span> |
| <span style="color:#008000;font-weight:bold"><aggregate</span><span style="color:#008000;font-weight:bold">></span>true<span style="color:#008000;font-weight:bold"></aggregate></span> |
| <span style="color:#008000;font-weight:bold"></configuration></span> |
| |
| <span style="color:#080;font-style:italic"><!--</span><span style="color:#080;font-style:italic">executions> |
| </span><span style="color:#080;font-style:italic"> <execution> |
| </span><span style="color:#080;font-style:italic"> <phase>install</phase> |
| </span><span style="color:#080;font-style:italic"> <goals> |
| </span><span style="color:#080;font-style:italic"> <goal>jxr</goal> |
| </span><span style="color:#080;font-style:italic"> <goal>test</span><span style="color:#080;font-style:italic">-</span><span style="color:#080;font-style:italic">jxr</goal> |
| </span><span style="color:#080;font-style:italic"> </goals> |
| </span><span style="color:#080;font-style:italic"> </execution> |
| </span><span style="color:#080;font-style:italic"> </executions </span><span style="color:#080;font-style:italic">--></span> |
| <span style="color:#008000;font-weight:bold"></plugin></span> |
| </code></pre></div><div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ <span style="color:#a2f">cd</span> target/checkout |
| $ mvn -Pserial site |
| </code></pre></div><p>This creates the site.</p> |
| <h3 id="step-7--sign-the-packages">Step 7 : Sign the packages</h3> |
| <p>Now, you have to sign the binary packages which are in target/checkout/distribution/target.</p> |
| <div class="note" markdown="1"> |
| Use your PGP key ID (the pub key, 4096R/[XXXXXXX] where [XXXXXXX] is the key ID) |
| </div> |
| <p>You can get the keys by typing :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">gpg --list-keys |
| </code></pre></div><p>You’ll get something like :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-text" data-lang="text">localhost:target elecharny$ gpg --list-keys |
| /Users/elecharny/.gnupg/pubring.gpg |
| ----------------------------------- |
| pub dsa2048 2009-12-03 [SCA] |
| C62BFD988278310B5B7A43D16FC4BEA60A8A0BBA |
| uid [ultimate] Emmanuel Lecharny <elecharny@nextury.com> |
| sub elg2048 2009-12-03 [E] |
| |
| pub rsa4096 2010-09-13 [SC] |
| 4D2DB2916149BAA9D0C92F3731474E5E7C6B7034 |
| uid [ultimate] Emmanuel Lecharny (CODE SIGNING KEY) <elecharny@apache.org> |
| sub rsa4096 2010-09-13 [E] |
| |
| ... |
| </code></pre></div><p>Take the long hexadecimal tart following the ‘pub’ part (ie “4D2DB2916149BAA9D0C92F3731474E5E7C6B7034” for the 4096 bits key)</p> |
| <p>Use a shell script to sign the packages which are stored in target/checkout/distribution/target. You will first have to delete the created .asc files :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-text" data-lang="text">localhost:target elecharny$ rm *.asc |
| localhost:target elecharny$ ~/sign.sh |
| PGP Key ID: |
| <your PGP key> |
| PGP Key Password: |
| <Your PGP passphrase> |
| |
| -n Signing: ./apache-mina-2.0.9-bin.tar.bz2 ... |
| - Generated './apache-mina-2.0.9-bin.tar.bz2.sha512' |
| - Generated './apache-mina-2.0.9-bin.tar.bz2.asc' |
| -n Signing: ./apache-mina-2.0.9-bin.tar.gz ... |
| - Generated './apache-mina-2.0.9-bin.tar.gz.sha512' |
| - Generated './apache-mina-2.0.9-bin.tar.gz.asc' |
| ... |
| </code></pre></div><p>Here is the <code>sign.sh</code> script you can use :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash"><span style="color:#080">#!/bin/sh |
| </span><span style="color:#080"></span> |
| <span style="color:#a2f">echo</span> <span style="color:#b44">"PGP Key ID: "</span> |
| <span style="color:#a2f">read</span> DEFAULT_KEY |
| |
| <span style="color:#a2f">echo</span> <span style="color:#b44">"PGP Key Password: "</span> |
| stty -echo |
| <span style="color:#a2f">read</span> PASSWORD |
| stty <span style="color:#a2f">echo</span> |
| <span style="color:#a2f">echo</span> <span style="color:#b44">""</span> |
| |
| <span style="color:#a2f;font-weight:bold">for</span> FILE in <span style="color:#a2f;font-weight:bold">$(</span>find . -maxdepth <span style="color:#666">1</span> -not <span style="color:#b44">'('</span> -name <span style="color:#b44">"sign.sh"</span> -or -name <span style="color:#b44">".*"</span> -or -name <span style="color:#b44">"*.sha256"</span> -or -name <span style="color:#b44">"*.sha512"</span> -or -name <span style="color:#b44">"*.asc"</span> <span style="color:#b44">')'</span> -and -type f<span style="color:#a2f;font-weight:bold">)</span> ; <span style="color:#a2f;font-weight:bold">do</span> |
| <span style="color:#a2f;font-weight:bold">if</span> <span style="color:#666">[</span> -f <span style="color:#b44">"</span><span style="color:#b8860b">$FILE</span><span style="color:#b44">.asc</span><span style="color:#b44">"</span> <span style="color:#666">]</span>; <span style="color:#a2f;font-weight:bold">then</span> |
| <span style="color:#a2f">echo</span> <span style="color:#b44">"</span><span style="color:#b44">Skipping: </span><span style="color:#b8860b">$FILE</span><span style="color:#b44">"</span> |
| <span style="color:#a2f;font-weight:bold">continue</span> |
| <span style="color:#a2f;font-weight:bold">fi</span> |
| |
| <span style="color:#a2f">echo</span> -n <span style="color:#b44">"</span><span style="color:#b44">Signing: </span><span style="color:#b8860b">$FILE</span><span style="color:#b44"> ... </span><span style="color:#b44">"</span> |
| |
| <span style="color:#080;font-style:italic"># SHA-512</span> |
| <span style="color:#a2f;font-weight:bold">if</span> <span style="color:#666">[</span> ! -f <span style="color:#b44">"</span><span style="color:#b8860b">$FILE</span><span style="color:#b44">.sha512</span><span style="color:#b44">"</span> <span style="color:#666">]</span>; |
| <span style="color:#a2f;font-weight:bold">then</span> |
| gpg -v --default-key <span style="color:#b44">"</span><span style="color:#b8860b">$DEFAULT_KEY</span><span style="color:#b44">"</span> --print-md SHA512 <span style="color:#b44">"</span><span style="color:#b8860b">$FILE</span><span style="color:#b44">"</span> > <span style="color:#b44">"</span><span style="color:#b8860b">$FILE</span><span style="color:#b44">"</span>.sha512 |
| <span style="color:#a2f">echo</span> <span style="color:#b44">"</span><span style="color:#b44"> - Generated '</span><span style="color:#b8860b">$FILE</span><span style="color:#b44">.sha512'</span><span style="color:#b44">"</span> |
| <span style="color:#a2f;font-weight:bold">else</span> |
| <span style="color:#a2f">echo</span> <span style="color:#b44">"</span><span style="color:#b44"> - Skipped '</span><span style="color:#b8860b">$FILE</span><span style="color:#b44">.sha512' (file already existing)</span><span style="color:#b44">"</span> |
| <span style="color:#a2f;font-weight:bold">fi</span> |
| |
| <span style="color:#080;font-style:italic"># ASC</span> |
| <span style="color:#a2f;font-weight:bold">if</span> <span style="color:#666">[</span> ! -f <span style="color:#b44">"</span><span style="color:#b8860b">$FILE</span><span style="color:#b44">.asc</span><span style="color:#b44">"</span> <span style="color:#666">]</span>; |
| <span style="color:#a2f;font-weight:bold">then</span> |
| <span style="color:#a2f">echo</span> <span style="color:#b44">"</span><span style="color:#b8860b">$PASSWORD</span><span style="color:#b44">"</span> | gpg --default-key <span style="color:#b44">"</span><span style="color:#b8860b">$DEFAULT_KEY</span><span style="color:#b44">"</span> --detach-sign --armor --no-tty --yes --passphrase-fd <span style="color:#666">0</span> <span style="color:#b44">"</span><span style="color:#b8860b">$FILE</span><span style="color:#b44">"</span> |
| <span style="color:#a2f">echo</span> <span style="color:#b44">"</span><span style="color:#b44"> - Generated '</span><span style="color:#b8860b">$FILE</span><span style="color:#b44">.asc'</span><span style="color:#b44">"</span> |
| <span style="color:#a2f;font-weight:bold">else</span> |
| <span style="color:#a2f">echo</span> <span style="color:#b44">"</span><span style="color:#b44"> - Skipped '</span><span style="color:#b8860b">$FILE</span><span style="color:#b44">.asc' (file already existing)</span><span style="color:#b44">"</span> |
| <span style="color:#a2f;font-weight:bold">fi</span> |
| <span style="color:#a2f;font-weight:bold">done</span> |
| </code></pre></div><h3 id="step-8--publish-source-and-binary-distribution-packages">Step 8 : Publish Source and Binary Distribution Packages</h3> |
| <p>The sources, binaries and their signatures, have to be pushed in a place where they can be downloaded by the other committers, in order to be checked while validating the release. As the ~/people.apache.org server is not anymore available for that purpose, we use the distribution space for that purpose.</p> |
| <p>If you haven’t checked out this space, do it now :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ mkdir -p ~/mina/dist/dev/mina |
| $ svn co https://dist.apache.org/repos/dist/dev/mina ~/mina/dist/dev/mina |
| </code></pre></div><p>That will checkout the full project distributions.</p> |
| <p>You may want to checkout only the part that you are going to generate, to avoid getting Gb of data :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ mkdir -p ~/mina/dist/dev/mina/mina |
| $ svn co https://dist.apache.org/repos/dist/dev/mina/mina ~/mina/dist/dev/mina/mina |
| </code></pre></div><p>Now, create a sub-directory for the version you have generated (here, for version 2.0.14) :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ mkdir ~/mina/dist/dev/mina/mina/2.0.14 |
| </code></pre></div><p>Then copy the packages :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ <span style="color:#a2f">cd</span> target/checkout/distributions/target |
| $ cp apache-mina-2.0.14-* ~/mina/dist/dev/mina/mina/2.0.14/ |
| </code></pre></div><p>Last, not least, commit your changes</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ svn add ~/mina/dist/dev/mina/mina/2.0.14 |
| $ svn ci ~/mina/dist/dev/mina/mina/2.0.14 -m <span style="color:#b44">"Apache MINA 2.0.14 packages"</span> |
| </code></pre></div><h3 id="step-9--test-the-new-version-with-ftpserver-sshd-and-vysper">Step 9 : Test the New Version with FtpServer, Sshd and Vysper</h3> |
| <p>In <em>FtpServer/pom.xml</em> change the <org.apache.directory.shared.version> property, build FtpServer. It should build with no error. Do the same thing with Sshd and Vysper.</p> |
| <p>It’s time to launch a vote !</p> |
| <h2 id="step-10--voting-a-release">Step 10 : Voting a release</h2> |
| <p>Once the tarballs have been created, and the binaries available in Nexus, a vote can be launched. Simply send a mail on the <a href="mailto:dev@mina.apache.org">dev@mina.apache.org</a> mailing list describing the new release.</p> |
| <p>Here is how you send a [VOTE] mail on the dev mailing list :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-text" data-lang="text">Hi, |
| |
| <blah blah blah> |
| |
| Here is the list of fixed issues : |
| |
| |
| * [DIRMINA-803 <https://issues.apache.org/jira/browse/DIRMINA-803>] |
| - ProtocolCodecFilter.filterWrite() is no longer thread-safe |
| * ... |
| |
| |
| Here's the Jira link for this version if you'd like to review issues in more details: |
| |
| https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=10670&styleName=Html&version=12313702 |
| |
| A temporary tag has been created (it can be removed if the vote is not approved) |
| |
| The newly approved Nexus has been used for the preparation of this release and all final artifacts are stored |
| in a staging repository: |
| https://repository.apache.org/content/repositories/orgapachemina-002/ |
| |
| |
| The distributions are available for download on : |
| https://repository.apache.org/content/repositories/orgapachemina-004/org/apache/mina/mina-parent/2.0.1/ |
| |
| Let us vote : |
| [ ] +1 | Release MINA 2.0.1 |
| [ ] +/- | Abstain |
| [ ] -1 | Do *NOT* release MINA 2.0.1 |
| |
| Thanks ! |
| </code></pre></div><p>The vote will be open for 72 hours. Once the delay is over, collect the votes, and count the binding +1/-1. If the vote is positive, then we can release.</p> |
| <h3 id="step-11--close-the-vote">Step 11 : Close the vote</h3> |
| <p>You can officially close the vote now. There are some more steps to fulfill :</p> |
| <ul> |
| <li>Release the project on the <a href="https://repository.apache.org">Nexus server</a></li> |
| <li>Copy the tarballs and heir signature in <a href="https://dist.apache.org/repos/dist/release/mina/mina">https://dist.apache.org/repos/dist/release/mina/mina</a></li> |
| </ul> |
| <p>The sources, binaries and their signatures, have to be pushed in a place where they can be downloaded by users. We use the <a href="https://dist.apache.org/repos/dist/release/mina/mina">distribution</a> space for that purpose.</p> |
| <p>Move the distribution packages (sources and binaries) to the dist SVN repository: <code>https://dist.apache.org/repos/dist/release/mina/mina/$(version)</code></p> |
| <p>If you haven’t checked out this space, do it now :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ mkdir -p ~/mina/dist/release/mina |
| $ svn co https://dist.apache.org/repos/dist/release/mina/mina ~/mina/dist/release/mina |
| </code></pre></div><p>That will checkout the full project distributions.</p> |
| <p>Then move the packages from ‘dev’ to ‘release’ :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">$ <span style="color:#a2f">cd</span> ~/mina/dist/release/mina |
| $ cp ~/mina/dist/dev/mina/mina/<version> . |
| $ svn add <version> |
| $ svn ci <version> |
| ... |
| $ <span style="color:#a2f">exit</span> |
| </code></pre></div><p>The packages should now be available on <a href="https://dist.apache.org/repos/dist/release/mina/mina/">https://dist.apache.org/repos/dist/release/mina/mina/</a> <version></p> |
| <h3 id="step-12-deploy-web-reports-javadoc-and-jxr">Step 12: Deploy Web Reports (JavaDoc and JXR)</h3> |
| <p>The javadoc and xref files have been generated in step 6, it’s now time to push them into the production site. They are generated in the following directory :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-text" data-lang="text">target/checkout/target/site |
| </code></pre></div><p>We will copy four directories :</p> |
| <div class="highlight"><pre style="background-color:#f8f8f8;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-text" data-lang="text">apidocs |
| testapidocs |
| xref |
| xref-test |
| </code></pre></div><p>They are uploaded to <a href="https://nightlies.apache.org/">https://nightlies.apache.org/</a> via WebDAV protocol.</p> |
| <p>First create the folders for the version (change the <version> part):</p> |
| <pre><code>$ curl -u <your asf id> -X MKCOL 'https://nightlies.apache.org/mina/mina/<version>/' |
| $ curl -u <your asf id> -X MKCOL 'https://nightlies.apache.org/mina/mina/<version>/apidocs' |
| $ curl -u <your asf id> -X MKCOL 'https://nightlies.apache.org/mina/mina/<version>/testapidocs' |
| $ curl -u <your asf id> -X MKCOL 'https://nightlies.apache.org/mina/mina/<version>/xref' |
| $ curl -u <your asf id> -X MKCOL 'https://nightlies.apache.org/mina/mina/<version>/xref-test' |
| </code></pre><p>Each of those commands will ask for your ASF password.</p> |
| <p>I used <strong>rclone</strong> to copy folders via WebDAV.</p> |
| <p>After intallation run rclone config and configure the nightlies connection:</p> |
| <pre><code>$ rclone config |
| name: nightlies |
| type: webdav |
| url: https://nightlies.apache.org |
| vendor: other |
| user: <your asf id> |
| pass: <your asf password> (will be stored encrypted) |
| </code></pre><p>Then copy the directories (change the <version> part):</p> |
| <pre><code>cd target/checkout/target/site |
| rclone copy --progress apidocs nightlies:/mina/mina/<version>/apidocs |
| rclone copy --progress testapidocs nightlies:/mina/mina/<version>/testapidocs |
| rclone copy --progress xref nightlies:/mina/mina/<version>/xref |
| rclone copy --progress xref-test nightlies:/mina/mina/<version>/xref-test |
| </code></pre><p>Finally update the links in the static/mina-project/gen-docs/.htaccess of the mina-site repo (change the <version> part):</p> |
| <pre><code>RewriteRule ^latest-2.1$ https://nightlies.apache.org/mina/mina/<version>/ [QSA,L] |
| RewriteRule ^latest-2.1/(.*)$ https://nightlies.apache.org/mina/mina/<version>/$1 [QSA,L] |
| </code></pre><p>Save and commit the file, the web site should be automatically generated and published.</p> |
| <h3 id="step-13-wait-24-hours">Step 13: Wait 24 hours</h3> |
| <p>We have to wait at least 24 hours for all mirrors to retrieve the uploaded files before making any announcement. I’d recommend you to wait for 48 hours because some mirrors might lag due to various issues.</p> |
| <h3 id="step-14-update-the-links-in-web-site">Step 14: Update the Links in Web Site</h3> |
| <p>Some pages have to be updated. Assuming the MINA site has been checked out in ~/mina/site (this can be done with the command <em>$ svn co <a href="https://svn.apache.org/viewvc/mina/site/trunk">https://svn.apache.org/viewvc/mina/site/trunk</a> ~/mina/site</em>), here are the pages that need to be changed :</p> |
| <ul> |
| <li>/config.toml: update the <code>version_mina_XYZ</code> variable with the new version.</li> |
| <li>/source/mina-project/news.md: add the news on top of this page</li> |
| <li>/source/mina-project/downloads-2_0.md or /source/mina-project/downloads-2_1.md or /source/mina-project/downloads-2_2.md: change the version all over the page</li> |
| <li>/source/downloads-mina_2_0.md or /source/downloads-mina2_1.md or /source/downloads-mina2_2.md: change the version all over the page</li> |
| <li>/source/mina-project/downloads-old.md: Add a line for the latest version which has been replaced by the released one</li> |
| </ul> |
| <p>Commit the changes, and publish the web site, you are done !</p> |
| <h3 id="step-15-wait-another-24-hours">Step 15: Wait another 24 hours</h3> |
| <p>We need to wait until any changes made in the web site and metadata file(s) go live.</p> |
| <h3 id="step-16-announce-the-new-release">Step 16: Announce the New Release</h3> |
| <p>An announcement message can be sent to [mailto:announce@apache.org], [mailto:announce@apachenews.org], [mailto:users@mina.apache.org] and [mailto:dev@mina.apache.org]. Please note that announcement messages are rejected unless your from-address ends with <code>@apache.org</code>. Plus, you shouldn’t forget to post a news to the MINA site main page.</p> |
| <p>Enjoy !</p> |
| |
|
|
|
|
|
|
| </div>
|
| <div id="endContent"></div>
|
| </div>
|
|
|
| <div id="footer">
|
| © 2003-2024, <a href="https://www.apache.org">The Apache Software Foundation</a> - <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy Policy</a><br />
|
| Apache MINA, MINA, Apache Vysper, Vysper, Apache SSHd, SSHd, Apache FtpServer, FtpServer, Apache AsyncWeb, AsyncWeb,
|
| Apache, the Apache feather logo, and the Apache Mina project logos are trademarks of The Apache Software Foundation.
|
| </div>
|
|
|
| </div>
|
|
|
| </body>
|
|
|
| </html>
|
