sis-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
Subject svn commit: r938996 - in /websites/staging/sis/trunk/content: ./ release-management.html
Date Wed, 04 Feb 2015 18:13:49 GMT
Author: buildbot
Date: Wed Feb  4 18:13:48 2015
New Revision: 938996

Staging update by buildbot for sis

    websites/staging/sis/trunk/content/   (props changed)

Propchange: websites/staging/sis/trunk/content/
--- cms:source-revision (original)
+++ cms:source-revision Wed Feb  4 18:13:48 2015
@@ -1 +1 @@

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 Wed Feb  4 18:13:48 2015
@@ -92,16 +92,16 @@ The intended audiences are SIS release m
 <li><a href="#directory-layout">Directory layout</a></li>
-<li><a href="#prepare-source">Prepare source code</a></li>
-<li><a href="#prepare-documentation">Prepare documentation</a><ul>
+<li><a href="#prepare-source">Prepare site and source code</a><ul>
+<li><a href="#prepare-documentation">Documentation</a></li>
 <li><a href="#prepare-website">Web site</a></li>
-<li><a href="#branch">Create branch</a><ul>
+<li><a href="#branch">Create branch and tag</a><ul>
 <li><a href="#branch-verify">Verify content</a></li>
+<li><a href="#tag">Tag the branch</a></li>
-<li><a href="#tag">Create tag</a></li>
 <li><a href="#maven-deploy">Deploy Maven artifacts</a><ul>
 <li><a href="#nexus-close">Verify and close the Nexus release artifacts</a></li>
 <li><a href="#nexus-text">Test the Nexus release artifacts</a></li>
@@ -140,10 +140,15 @@ the current release attempt. Those versi
 <span class="nb">export </span><span class="nv">NEW_VERSION</span><span
 <span class="nb">export </span><span class="nv">RELEASE_CANDIDATE</span><span
 <span class="nb">export </span><span class="nv">SIGNING_KEY</span><span
class="o">=</span>&lt;your key ID&gt;
+<span class="nb">export </span><span class="nv">BOOTCLASSPATH</span><span
class="o">=</span>&lt;path to the rt.jar file of a JDK6 installation&gt;
-<p>Tip: to see the key IDs, execute <code>gpg --list-keys</code>.</p>
+<p>The key ID value can be found be executing <code>gpg --list-keys</code>.
+The boot class path value is highly system-dependent. Some examples are:</p>
on MacOS.</li>
 <h2 id="directory-layout">Directory layout</h2>
 <p>The steps described in this page assume the following directory layout (some directories
will be created as
 a result of the steps). Any other layout can be used. However if the layout differs, then
the relative paths
@@ -165,14 +170,14 @@ in this page shall be adjusted according
-<h1 id="prepare-source">Prepare source code</h1>
+<h1 id="prepare-source">Prepare site and source code</h1>
 <p>Before to start the release process:</p>
 <li>Review and update the <code>README</code> file on the <code>trunk</code>
source code repository.</li>
 <li>Review the <code>javac</code> and <code>javadoc</code>
warnings reported by Jenkins and fix at least the typos.</li>
 <li>Ensure that the <code>trunk</code> build is successful (including tests)
with JDK6, JDK7 and JDK8.</li>
-<h1 id="prepare-documentation">Prepare documentation</h1>
+<h2 id="prepare-documentation">Documentation</h2>
 <p>Update <a href="">JIRA</a> tasks
and prepare release notes as below:</p>
 <li>Ensure that the <em>Fix Version</em> in issues resolved since the last
release includes this release version correctly.</li>
@@ -202,7 +207,7 @@ svn commit --message <span class="s2">&q
 <p>The new web site will be published in the <a href="">staging
 It will not yet be published on <code></code>.</p>
-<h1 id="branch">Create branch</h1>
+<h1 id="branch">Create branch and tag</h1>
 <p>Execute the following command:</p>
 <div class="codehilite"><pre>svn copy
<span class="se">\</span>
<span class="nv">$NEW_VERSION</span>
<span class="se">\</span>
@@ -227,17 +232,15 @@ but also in a few Java files. The follow
 <p>Open the root <code>pom.xml</code> file in an editor and perform the
following changes:</p>
-<li>Copy-and-paste the whole <code>&lt;plugin&gt;</code> block,
except <code>&lt;reportSets&gt;</code>, for <code>maven-javadoc-plugin</code>
from <code>&lt;reporting&gt;</code> to <code>&lt;build&gt;</code>.
-    We need the javadoc configuration to be duplicated in both <code>&lt;reporting&gt;</code>
and <code>&lt;build&gt;</code> sections in order
-    to get the expected Javadoc output in both Maven site and in the <code>*-javadoc.jar</code>
files to deployed in the
-    Maven repository. <strong>TODO:</strong> see if upgrading Maven or the <code>maven-javadoc-plugin</code>
can solve this problem.</li>
-<li>Remove the whole <code>&lt;pluginRepositories&gt;</code> block,
since it should not be needed for releases (and is actually not allowed).</li>
-<li>Remove the <code>&lt;plugin&gt;</code> block for <code>docbkx-maven-plugin</code>,
since the DocBook directory is omitted (see below).</li>
+<li>Remove the whole <code>&lt;pluginRepositories&gt;</code> block
(including comment), since it should not be needed for releases (and is actually not allowed).</li>
-<p>Recursively delete the <code>src/main/docbook</code> directory (this
policy may be revised in future SIS releases).
-We omit this directory for now because this material may move to the CMS, and no English
version is available yet.</p>
 <p>In <code>core/sis-utility/src/main/java/org/apache/sis/internal/system/</code>,
consider setting
 the <code>ENABLED</code> flag to <code>false</code>. This policy
may be revised in future SIS releases.</p>
+<p>Remove the workaround for the bug in JDK6 <code>javadoc</code>, since
we perform release with JDK7 or JDK8:</p>
+<div class="codehilite"><pre>svn remove core/sis-build-helper/src/main/java/org/opengis
 <p>Commit the changes on the branch:</p>
 <div class="codehilite"><pre>svn commit --message <span class="s2">&quot;Prepare
the branch for the $NEW_VERSION release.&quot;</span>
@@ -255,7 +258,7 @@ Note that MacOS users can skip this step
 It will not complete the prepare goal until all snapshot dependencies are resolved.
 If anything goes wrong, the directory can be cleaned by running the <code>release:clean</code>
 before to fix the problem and try again.</p>
-<div class="codehilite"><pre>mvn release:prepare --define <span class="nv">releaseVersion</span><span
class="o">=</span><span class="nv">$NEW_VERSION</span> --define <span
class="nv">tag</span><span class="o">=</span><span class="nv">$NEW_VERSION</span>
<span class="se">\</span>
+<div class="codehilite"><pre>mvn release:prepare --define <span class="nv">releaseVersion</span><span
class="o">=</span><span class="nv">$NEW_VERSION</span> --define <span
class="nv">tag</span><span class="o">=</span><span class="nv">$NEW_VERSION</span>
--define <span class="nv">bootclasspath</span><span class="o">=</span><span
class="nv">$BOOTCLASSPATH</span> <span class="se">\</span>
     --define <span class="nv">autoVersionSubmodules</span><span class="o">=</span><span
class="nb">true</span> --define <span class="nv">updateWorkingCopyVersions</span><span
class="o">=</span><span class="nb">false</span> --define <span class="nv">dryRun</span><span
class="o">=</span><span class="nb">true</span>
@@ -267,7 +270,7 @@ the changes that would have been committ
-<h1 id="tag">Create tag</h1>
+<h2 id="tag">Tag the branch</h2>
 <p>In theory, the next commands would be a real (non-dry) run of <code>mvn release:prepare</code>,
followed by <code>mvn release:perform</code>.
 However we perform those steps manually rather than relying on Maven for the following reasons:</p>
@@ -591,13 +594,18 @@ svn delete
     The email needs to be sent from an <code></code> email address.</li>
 <h1 id="next-release">Update trunk for the next development cycle</h1>
-<p>Update the version numbers in the <code>pom.xml</code> files on trunk
with the following command:</p>
+<p>On the development branch (usually JDK8),
+update the version numbers in the <code>pom.xml</code> files on trunk with the
following command:</p>
 <div class="codehilite"><pre>mvn release:update-versions --define <span class="nv">autoVersionSubmodules</span><span
class="o">=</span><span class="nb">true</span>
-<p>Edit the version number in the <code>application/sis-console/src/main/artifact/README</code>
-Report the changes manually on the JDK6, JDK7 and JDK8 branches.</p>
+<p>This change will need to be merged manually on the JDK7, JDK6 branches and on the
+Then on the development branch:</p>
+<li>Edit the version number in the <code>application/sis-console/src/main/artifact/README</code>
+<li>Edit the value of the <code>MAJOR_VERSION</code> constant in the <code>core/sis-utility/src/main/java/org/apache/sis/internal/system/</code>

View raw message