sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From build...@apache.org
Subject svn commit: r873749 - in /websites/staging/sis/trunk/content: ./ release-management.html
Date Fri, 09 Aug 2013 16:36:22 GMT
Author: buildbot
Date: Fri Aug  9 16:36:22 2013
New Revision: 873749

Log:
Staging update by buildbot for sis

Modified:
    websites/staging/sis/trunk/content/   (props changed)
    websites/staging/sis/trunk/content/release-management.html

Propchange: websites/staging/sis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Aug  9 16:36:22 2013
@@ -1 +1 @@
-1512284
+1512385

Modified: websites/staging/sis/trunk/content/release-management.html
==============================================================================
--- websites/staging/sis/trunk/content/release-management.html (original)
+++ websites/staging/sis/trunk/content/release-management.html Fri Aug  9 16:36:22 2013
@@ -105,7 +105,13 @@ The intended audiences are SIS release m
 <li><a href="#nexus-close">Verify and close the Nexus release artifacts</a></li>
 </ul>
 </li>
-<li><a href="#stage">Stage the source, binary and javadoc artifacts</a></li>
+<li><a href="#stage">Stage the source, binary and javadoc artifacts</a><ul>
+<li><a href="#dist">Initialize the distribution directory</a></li>
+<li><a href="#binary">Create the binary artifact</a></li>
+<li><a href="#sign">Sign and commit</a></li>
+<li><a href="#apidocs">Update online Javadoc</a></li>
+</ul>
+</li>
 <li><a href="#vote">Put the release candidate up for a vote</a><ul>
 <li><a href="#veto">Recovering from a vetoed release</a></li>
 </ul>
@@ -201,6 +207,7 @@ but can be replaced by anything else), t
 <div class="codehilite"><pre><span class="nb">cd</span> ../branches
 svn checkout https://svn.apache.org/repos/asf/sis/branches/<span class="nv">$NEW_VERSION</span>
 <span class="nb">cd</span> <span class="nv">$NEW_VERSION</span>
+<span class="nb">export </span><span class="nv">BRANCH_DIR</span><span
class="o">=</span><span class="sb">`</span><span class="nb">pwd</span><span
class="sb">`</span>
 </pre></div>
 
 
@@ -272,6 +279,7 @@ However we perform those steps manually 
 <div class="codehilite"><pre><span class="nb">cd</span> ../../tags
 svn checkout https://svn.apache.org/repos/asf/sis/tags/<span class="nv">$NEW_VERSION</span>
 <span class="nb">cd</span> <span class="nv">$NEW_VERSION</span>
+<span class="nb">export </span><span class="nv">TAG_DIR</span><span
class="o">=</span><span class="sb">`</span><span class="nb">pwd</span><span
class="sb">`</span>
 </pre></div>
 
 
@@ -284,7 +292,7 @@ plus some additional files:</p>
 <p>Compare with the modifications done by <code>mvn release:prepare</code>.
The following command should report no difference,
 ignoring the license or other information that may have been removed by the Maven plugin
 (this has been known to happen if the starting <code>&lt;project&gt;</code>
tag is not on a single line).</p>
-<div class="codehilite"><pre>find . -name <span class="s2">&quot;pom.xml&quot;</span>
-exec diff <span class="s1">&#39;{}&#39;</span> ../../branches/<span
class="nv">$NEW_VERSION</span>/<span class="s1">&#39;{}&#39;</span>.tag
<span class="se">\;</span>
+<div class="codehilite"><pre>find . -name <span class="s2">&quot;pom.xml&quot;</span>
-exec diff <span class="s1">&#39;{}&#39;</span> <span class="nv">$BRANCH_DIR</span>/<span
class="nv">$NEW_VERSION</span>/<span class="s1">&#39;{}&#39;</span>.tag
<span class="se">\;</span>
 </pre></div>
 
 
@@ -294,18 +302,26 @@ ignoring the license or other informatio
 
 
 <p>Clean the branch, since we will not need it anymore:</p>
-<div class="codehilite"><pre><span class="nb">cd</span> ../../branches/<span
class="nv">$NEW_VERSION</span>
+<div class="codehilite"><pre><span class="nb">cd </span>BRANCH_DIR/<span
class="nv">$NEW_VERSION</span>
 mvn release:clean
 mvn clean
-<span class="nb">cd</span> ../../tags/<span class="nv">$NEW_VERSION</span>
 </pre></div>
 
 
 <h1 id="maven-deploy">Deploy Maven artifacts</h1>
-<p>Ensure that the current directory is <code>tags/$NEW_VERSION</code>.
-Execute an <code>install</code> phase first (required for our custom <code>sis-build-helper</code>
plugin), then deploy.</p>
-<div class="codehilite"><pre>mvn clean install
-mvn deploy --activate-profiles apache-release
+<p>Execute an <code>install</code> phase first (required for our custom
<code>sis-build-helper</code> plugin),
+and generate the binary artifact (<code>pack.gz</code> file). The later will
fail if duplicated
+class files or resources are found. Consequently building the <code>pack.gz</code>
file is an
+additional test worth to do before deployment.
+.</p>
+<div class="codehilite"><pre><span class="nb">cd</span> <span
class="nv">$TAG_DIR</span>
+mvn clean install
+mvn org.apache.sis.core:sis-build-helper:<span class="nv">$NEW_VERSION</span>:pack
--non-recursive
+</pre></div>
+
+
+<p>If the above succeeded, deploy:</p>
+<div class="codehilite"><pre>mvn deploy --activate-profiles apache-release
 </pre></div>
 
 
@@ -323,23 +339,24 @@ Select any <code>*.html</code> file whic
 Click on that file and verify that the custom elements are rendered properly.
 In particular, all Java code snippets are missing if the <code>@preformat</code>
taglet had not be properly registered,
 so try to see at least one code snippet.</p>
-<p>Delete all <code>org/apache/sis/parent/$NEW_VERSION/parent-$NEW_VERSION-source-release.zip.*</code>
files on the Nexus repository.
-They should not be there - source release will be deployed on an other repository later.</p>
-<p>Delete all <code>org/apache/sis/*/$NEW_VERSION/*-$NEW_VERSION-site.xml.*</code>
files.
-There is no apparent reason for deploying Maven web site descriptors.</p>
-<p>Close the Nexus staging repository: click the checkboxes for the open staging repositories
-(<code>org.apache.sis-&lt;id&gt;</code>) and press <em>Close</em>
in the menu bar.
-In the description field, enter <code>SIS $NEW_VERSION-$RELEASE_CANDIDATE</code>
-(replace <code>$NEW_VERSION</code> and <code>$RELEASE_CANDIDATE</code>
by appropriate values.
-This will not be done automatically since this field box is not our bash shell!).</p>
-<p>Click on the <code>org.apache.sis-&lt;id&gt;</code> link in
order to get the URL to the temporary Maven repository created by Nexus.
-Announce on the <code>dev@</code> mailing list the availability of this temporary
repository for testing purpose.</p>
+<p>Additional cleaning:</p>
+<ul>
+<li>Delete all <code>org/apache/sis/parent/$NEW_VERSION/parent-$NEW_VERSION-source-release.zip.*</code>
files on the Nexus repository.
+    They should not be there - source release will be deployed on an other repository later.</li>
+<li>Delete all <code>org/apache/sis/*/$NEW_VERSION/*-$NEW_VERSION-site.xml*</code>
files.
+    There is no apparent reason for deploying Maven web site descriptors.</li>
+</ul>
+<p>Close the Nexus staging repository:</p>
+<ul>
+<li>Click the checkboxes for the open staging repositories (<code>org.apache.sis-&lt;id&gt;</code>)
and press <em>Close</em> in the menu bar.</li>
+<li>In the description field, enter "<code>SIS $NEW_VERSION-$RELEASE_CANDIDATE</code>"
+    (replace <code>$NEW_VERSION</code> and <code>$RELEASE_CANDIDATE</code>
by appropriate values.
+    This will not be done automatically since this field box is not our bash shell!).</li>
+<li>Click on the <code>org.apache.sis-&lt;id&gt;</code> link in
order to get the URL to the temporary Maven repository created by Nexus.</li>
+</ul>
+<p>We will announce later (in the <cite>Put the release candidate up for a vote</cite>
section) on the <code>dev@</code> mailing list
+the availability of this temporary repository for testing purpose.</p>
 <h1 id="stage">Stage the source, binary and javadoc artifacts</h1>
-<p>Create the binary artifact (<code>pack.gz</code> file):</p>
-<div class="codehilite"><pre>mvn org.apache.sis.core:sis-build-helper:<span
class="nv">$NEW_VERSION</span>:pack --non-recursive
-</pre></div>
-
-
 <p>Generate the Javadoc. While not mandatory, we suggest to use JDK 7 or above for
getting the new look and feel,
 getting the Javadoc enhancements expected in future JDK releases (more dynamic pages),
 avoiding the security vulnerability discovered in the Javadoc tools of older JDK releases,
@@ -354,33 +371,49 @@ zip -9 -r apache-sis-<span class="nv">$N
 </pre></div>
 
 
+<h2 id="dist">Initialize the distribution directory</h2>
 <p>Create the directory for the new version and release candidate within the distribution
directory.
-The <code>$RELEASE_CANDIDATE</code> number shall correspond to the current release
attempt.</p>
+The <code>$RELEASE_CANDIDATE</code> variable shall be the number of current release
attempt.</p>
 <div class="codehilite"><pre><span class="nb">cd</span> ../../distribution
 mkdir -p <span class="nv">$NEW_VERSION</span>/RC<span class="nv">$RELEASE_CANDIDATE</span>
 svn add <span class="nv">$NEW_VERSION</span>
+<span class="nb">cd</span> <span class="nv">$NEW_VERSION</span>/RC<span
class="nv">$RELEASE_CANDIDATE</span>
+<span class="nb">export </span><span class="nv">DIST_DIR</span><span
class="o">=</span><span class="sb">`</span><span class="nb">pwd</span><span
class="sb">`</span>
 </pre></div>
 
 
 <p>Copy the <code>HEADER.html</code> file from the previous release.
 Update the file content if necessary.</p>
-<div class="codehilite"><pre><span class="n">cd</span> $<span
class="n">NEW_VERSION</span><span class="o">/</span><span class="n">RC</span>$<span
class="n">RELEASE_CANDIDATE</span>
-<span class="n">svn</span> <span class="n">copy</span> <span class="n">https</span><span
class="p">:</span><span class="o">//</span><span class="n">dist</span><span
class="p">.</span><span class="n">apache</span><span class="p">.</span><span
class="n">org</span><span class="o">/</span><span class="n">repos</span><span
class="o">/</span><span class="n">dist</span><span class="o">/</span><span
class="n">release</span><span class="o">/</span><span class="n">sis</span><span
class="o">/</span>$<span class="n">OLD_VERSION</span><span class="o">/</span><span
class="n">HEADER</span><span class="p">.</span><span class="n">html</span>
<span class="p">.</span>
+<div class="codehilite"><pre>svn copy https://dist.apache.org/repos/dist/release/sis/<span
class="nv">$OLD_VERSION</span>/HEADER.html .
 </pre></div>
 
 
 <p>Move the files generated by Maven to the distribution directory:</p>
-<div class="codehilite"><pre><span class="n">mv</span> <span class="p">.</span><span
class="o">./</span><span class="p">.</span><span class="o">./</span><span
class="p">.</span><span class="o">./</span><span class="n">tags</span><span
class="o">/</span>$<span class="n">NEW_VERSION</span><span class="o">/</span><span
class="n">target</span><span class="o">/</span><span class="n">sis</span><span
class="o">-</span>$<span class="n">NEW_VERSION</span><span class="o">-*</span>
<span class="p">.</span>
-<span class="n">mv</span> <span class="p">.</span><span class="o">./</span><span
class="p">.</span><span class="o">./</span><span class="p">.</span><span
class="o">./</span><span class="n">tags</span><span class="o">/</span>$<span
class="n">NEW_VERSION</span><span class="o">/</span><span class="n">target</span><span
class="o">/</span><span class="n">site</span><span class="o">/</span><span
class="n">apache</span><span class="o">-</span><span class="n">sis</span><span
class="o">-</span>$<span class="n">NEW_VERSION</span><span class="o">-*</span>
<span class="p">.</span>
+<div class="codehilite"><pre>mv <span class="nv">$TAG_DIR</span>/target/sis-<span
class="nv">$NEW_VERSION</span>-* .
+mv <span class="nv">$TAG_DIR</span>/target/site/apache-sis-<span class="nv">$NEW_VERSION</span>-*
.
 </pre></div>
 
 
 <p>Rename the files to something more conform to the convention seen in other Apache
projects:</p>
-<div class="codehilite"><pre><span class="n">mv</span> <span class="n">sis</span><span
class="o">-</span>$<span class="n">NEW_VERSION</span><span class="o">-</span><span
class="n">source</span><span class="o">-</span><span class="n">release</span><span
class="p">.</span><span class="n">zip</span>     <span class="n">apache</span><span
class="o">-</span><span class="n">sis</span><span class="o">-</span>$<span
class="n">NEW_VERSION</span><span class="o">-</span><span class="n">src</span><span
class="p">.</span><span class="n">zip</span>
-<span class="n">mv</span> <span class="n">sis</span><span class="o">-</span>$<span
class="n">NEW_VERSION</span><span class="o">-</span><span class="n">source</span><span
class="o">-</span><span class="n">release</span><span class="p">.</span><span
class="n">zip</span><span class="p">.</span><span class="n">asc</span>
<span class="n">apache</span><span class="o">-</span><span class="n">sis</span><span
class="o">-</span>$<span class="n">NEW_VERSION</span><span class="o">-</span><span
class="n">src</span><span class="p">.</span><span class="n">zip</span><span
class="p">.</span><span class="n">asc</span>
+<div class="codehilite"><pre>mv sis-<span class="nv">$NEW_VERSION</span>-source-release.zip
    apache-sis-<span class="nv">$NEW_VERSION</span>-src.zip
+mv sis-<span class="nv">$NEW_VERSION</span>-source-release.zip.asc apache-sis-<span
class="nv">$NEW_VERSION</span>-src.zip.asc
 </pre></div>
 
 
+<h2 id="binary">Create the binary artifact</h2>
+<p>Create the binary artifact:</p>
+<div class="codehilite"><pre>cp -r <span class="nv">$TAG_DIR</span>/application/sis-console/src/main/artifact
apache-sis-<span class="nv">$NEW_VERSION</span>
+<span class="nb">cd </span>apache-sis-<span class="nv">$NEW_VERSION</span>
+cp <span class="nv">$TAG_DIR</span>/LICENSE .
+cp <span class="nv">$TAG_DIR</span>/NOTICE .
+mv <span class="nv">$TAG</span>/target/bundles/sis-<span class="nv">$NEW_VERSION</span>.pack.gz
lib/sis.pack.gz
+<span class="nb">cd</span> ..
+zip -9 -r apache-sis-<span class="nv">$NEW_VERSION</span>-bin.zip apache-sis-<span
class="nv">$NEW_VERSION</span>
+rm -r apache-sis-<span class="nv">$NEW_VERSION</span>
+</pre></div>
+
+
+<h2 id="sign">Sign and commit</h2>
 <p>Sign the source, javadoc and binary artifacts:</p>
 <div class="codehilite"><pre>gpg --print-md SHA512 apache-sis-<span class="nv">$NEW_VERSION</span>-src.zip
&gt; apache-sis-<span class="nv">$NEW_VERSION</span>-src.zip.sha
 gpg --print-md MD5    apache-sis-<span class="nv">$NEW_VERSION</span>-src.zip
&gt; apache-sis-<span class="nv">$NEW_VERSION</span>-src.zip.md5
@@ -389,24 +422,26 @@ gpg --armor --detach-sign --default-key 
 gpg --print-md SHA512 apache-sis-<span class="nv">$NEW_VERSION</span>-doc.zip
&gt; apache-sis-<span class="nv">$NEW_VERSION</span>-doc.zip.sha
 gpg --print-md MD5    apache-sis-<span class="nv">$NEW_VERSION</span>-doc.zip
&gt; apache-sis-<span class="nv">$NEW_VERSION</span>-doc.zip.md5
 
-gpg --armor --detach-sign --default-key <span class="nv">$SIGNING_KEY</span>
   apache-sis-<span class="nv">$NEW_VERSION</span>.pack.gz
-gpg --print-md SHA512 apache-sis-<span class="nv">$NEW_VERSION</span>.pack.gz
&gt; apache-sis-<span class="nv">$NEW_VERSION</span>.pack.gz.sha
-gpg --print-md MD5    apache-sis-<span class="nv">$NEW_VERSION</span>.pack.gz
&gt; apache-sis-<span class="nv">$NEW_VERSION</span>.pack.gz.md5
+gpg --armor --detach-sign --default-key <span class="nv">$SIGNING_KEY</span>
   apache-sis-<span class="nv">$NEW_VERSION</span>-bin.zip
+gpg --print-md SHA512 apache-sis-<span class="nv">$NEW_VERSION</span>-bin.zip
&gt; apache-sis-<span class="nv">$NEW_VERSION</span>-bin.zip.sha
+gpg --print-md MD5    apache-sis-<span class="nv">$NEW_VERSION</span>-bin.zip
&gt; apache-sis-<span class="nv">$NEW_VERSION</span>-bin.zip.md5
 </pre></div>
 
 
 <p>Commit:</p>
-<div class="codehilite"><pre><span class="nb">cd</span> ../..
+<div class="codehilite"><pre>svn add apache-sis-<span class="nv">$NEW_VERSION</span>-*
+<span class="nb">cd</span> ../..
 svn commit --message <span class="s2">&quot;SIS release candidate $RELEASE_CANDIDATE&quot;</span>
 </pre></div>
 
 
 <p>Verify that the files are downloadable from the
 [https://dist.apache.org/repos/dist/dev/sis/][https://dist.apache.org/repos/dist/dev/sis/]
sub-directory.</p>
+<h2 id="apidocs">Update online Javadoc</h2>
 <p>Copy the Javadoc to the web site staging directory:</p>
 <div class="codehilite"><pre><span class="nb">cd</span> ../site/content
 rm -r apidocs
-unzip ../../distribution/0.3/RC1/apache-sis-0.3-doc.zip
+unzip <span class="nv">$DIST_DIR</span>/apache-sis-0.3-doc.zip
 </pre></div>
 
 



Mime
View raw message