Author: buildbot
Date: Mon Dec 10 12:24:12 2012
New Revision: 841393
Log:
Staging update by buildbot for isis
Removed:
websites/staging/isis/trunk/content/contributors/release-process-rat-exclusions.html
Modified:
websites/staging/isis/trunk/cgi-bin/ (props changed)
websites/staging/isis/trunk/content/ (props changed)
websites/staging/isis/trunk/content/contributors/release-process.html
websites/staging/isis/trunk/content/contributors/release-snapshot.html
websites/staging/isis/trunk/content/documentation.html
Propchange: websites/staging/isis/trunk/cgi-bin/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Dec 10 12:24:12 2012
@@ -1 +1 @@
-1419364
+1419369
Propchange: websites/staging/isis/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Mon Dec 10 12:24:12 2012
@@ -1 +1 @@
-1419364
+1419369
Modified: websites/staging/isis/trunk/content/contributors/release-process.html
==============================================================================
--- websites/staging/isis/trunk/content/contributors/release-process.html
(original)
+++ websites/staging/isis/trunk/content/contributors/release-process.html Mon
Dec 10 12:24:12 2012
@@ -301,195 +301,142 @@ mvn clean install -o
All remaining steps should be performed in the base directory of the module
being released.
</div></p>
-<!--
-- site builds ok
-
-
-
-8daeb02ea775a67d739f8b27afce0e56
-
-
-
-
-
-60f9fef3ce8fa7f4c9ac817ef6d43ba3
-
-
-
-
-74cd298b4ccd450e8e87b027b532ad2f
-
-
-
-Make sure that all source code has been cleaned up and formatted according to
the Apache Isis and ASF conventions. Full details are in [Isis coding
conventions](coding-conventions.html).
-
-
-
-f762b180b7af28fab242c26d0c5f48b8
-
-
-
-The Apache Release Audit Tool `RAT` (from the [Apache
Creadur](http://creadur.apache.org) project) checks for missing license header
files.
-
-The parent `pom.xml` of each releasable module specifies the RAT Maven plugin,
with a number of custom exclusions.
-
-To run the RAT tool, use:
-
-
-
-9c6ea6ce5e449ec8111b32d6271f5131
-
-
-
-where `rat.numUnapprovedLicenses` property is set to a high figure,
temporarily overriding the default value of 0. This will allow the command to
run over all submodules, rather than failing after the first one.
-
-<div class="note">
-Do *not* use `mvn rat:check`; depending on your local Maven configuratoin this
may bring down the obsolete `mvn-rat-plugin` from Codehaus repo.
-</div>
-
-All being well the command should complete. For each failing submodule, it
will have written out a `target\rat.txt`; missing license notes are indicated
using the key `!???`. You can collate these together using something like:
-
-
-34cc167261a1dd19efcf253f0f73de73
-
-
-
-Investigate and fix any reported violations, typically by either:
-
-
-
-d9f0f52c516be130c53e93535bd5980f
-
-
-To add missing headers, you can if you wish use the groovy script
`addmissinglicenses.groovy` to automatically insert missing headers for certain
file types. The actual files checked are those with extensions specified in
the line `def fileEndings = [".java", ".htm"]`:
-
-
-
-93bfa782cabaac71742021050c9e50cc
+<h3>Code cleanup / formatting</h3>
+<p>Make sure that all source code has been cleaned up and formatted according
to the Apache Isis and ASF conventions. Full details are in <a
href="coding-conventions.html">Isis coding conventions</a>.</p>
-b460e06e4a17f240d0e761b506f13641
+<h2>License header notices (RAT tool)</h2>
+<p>The Apache Release Audit Tool <code>RAT</code> (from the <a
href="http://creadur.apache.org";>Apache Creadur</a> project) checks for missing
license header files.</p>
+<p>The parent <code>pom.xml</code> of each releasable module specifies the RAT
Maven plugin, with a number of custom exclusions.</p>
+<p>To run the RAT tool, use:</p>
+<pre>
+mvn org.apache.rat:apache-rat-plugin:check -D rat.numUnapprovedLicenses=50 -o
+</pre>
-ed32a4e87365839d451b6b0cf3c405b5
-
-
-1896300a163310f827c151fb370939d7
-
-
-
-Once you've fixed all issues, confirm once more that `apache-rat-plugin` no
longer reports any license violations, this time leaving the
`rat.numUnapprovedLicenses` property to its default, 0:
-
-
-
-22d5ba6e4d30d5dd07a4fea7734c70c0
-
-
-
-
-
-
-6148a0ccbf70a2dc3ec77678ce7d1b13
-
+<p>where <code>rat.numUnapprovedLicenses</code> property is set to a high
figure, temporarily overriding the default value of 0. This will allow the
command to run over all submodules, rather than failing after the first one.</p>
+<p><div class="note">
+Do <em>not</em> use <code>mvn rat:check</code>; depending on your local Maven
configuratoin this may bring down the obsolete <code>mvn-rat-plugin</code> from
Codehaus repo.
+</div></p>
-Although Apache Isis has no dependencies which have incompatible licenses, the
POMs for some of these dependencies (in the Maven central repo) do not
necessarily contain the required license information. Without appropriate
additional configuration, this would result in the generated `DEPENDENCIES`
file and generated Maven site indicating dependencies as having "unknown"
licenses.
+<p>All being well the command should complete. For each failing submodule, it
will have written out a <code>target\rat.txt</code>; missing license notes are
indicated using the key <code>!???</code>. You can collate these together
using something like:</p>
-Fortunately, Maven allows the missing information to be provided by
configuring the `maven-remote-resources-plugin`. This is stored in the
`src/main/appended-resources/supplemental-models.xml` file in the parent
`[oai:isis]` module.
+<pre>
+for a in `find . -name rat.txt -print`; do grep '!???' $a; done
+</pre>
-To capture the missing license information, use:
+<p>Investigate and fix any reported violations, typically by either:</p>
+<ul>
+<li>adding genuinely missing license headers from Java (or other) source
files, or</li>
+<li>updating the <code><excludes></code> element for the
<code>apache-rat-plugin</code> plugin to ignore test files, log files and any
other non-source code files
+<ul>
+<li>also look to remove any stale <code><exclude></code> entries</li>
+</ul></li>
+</ul>
+<p>To add missing headers, you can if you wish use the groovy script
<code>addmissinglicenses.groovy</code> to automatically insert missing headers
for certain file types. The actual files checked are those with extensions
specified in the line <code>def fileEndings = [".java", ".htm"]</code>:</p>
-8c71e43fd0463059c7b0fc3acaf5adca
+<ul>
+<li>dry run:</li>
+</ul>
+<pre>
+groovy addmissinglicenses.groovy
+</pre>
+<ul>
+<li>or to actually execute:</li>
+</ul>
-This Maven plugin creates a `licensexml` file in the
`target/generated-resources` directory of each module.
+<pre>
+groovy addmissinglicenses.groovy -x
+</pre>
-Then, run the following script (shown here relative to the `core` module).
+<p>Once you've fixed all issues, confirm once more that
<code>apache-rat-plugin</code> no longer reports any license violations, this
time leaving the <code>rat.numUnapprovedLicenses</code> property to its
default, 0:</p>
+<pre>
+mvn org.apache.rat:apache-rat-plugin:check -D rat.numUnapprovedLicenses=0 -o
+for a in `find . -name rat.txt -print`; do grep '!???' $a; done
+</pre>
-417bbfc3142d352bf5241ba1acaae3c9
+<h2>Missing License Check</h2>
+<p>Although Apache Isis has no dependencies which have incompatible licenses,
the POMs for some of these dependencies (in the Maven central repo) do not
necessarily contain the required license information. Without appropriate
additional configuration, this would result in the generated
<code>DEPENDENCIES</code> file and generated Maven site indicating dependencies
as having "unknown" licenses.</p>
+<p>Fortunately, Maven allows the missing information to be provided by
configuring the <code>maven-remote-resources-plugin</code>. This is stored in
the <code>src/main/appended-resources/supplemental-models.xml</code> file in
the parent <code>[oai:isis]</code> module.</p>
-This searches for all `licenses.xml` files, and compares them against the
contents of the `supplemental-models.xml` file. For example, the output could
be something like:
+<p>To capture the missing license information, use:</p>
+<pre>
+mvn license:download-licenses
+</pre>
+<p>This Maven plugin creates a <code>licensexml</code> file in the
<code>target/generated-resources</code> directory of each module.</p>
-87975db852b62990bd1a4becc1a32fcf
+<p>Then, run the following script (shown here relative to the
<code>core</code> module).</p>
+<pre>
+groovy ../scripts/checkmissinglicenses.groovy
+</pre>
+<p>This searches for all <code>licenses.xml</code> files, and compares them
against the contents of the <code>supplemental-models.xml</code> file. For
example, the output could be something like:</p>
-If any missing entries are listed or are spurious, then update
`supplemental-models.xml` and try again.
+<pre>
+licenses to add to supplemental-models.xml:
-<div class="note">
-Ignore any missing license warnings for the TCK modules; this is a result of
the TCK modules for the viewers (eg `bdd-concordion-tck`) depending on the TCK
dom, fixtures etc.
-</div>
+[org.slf4j, slf4j-api, 1.5.7]
+[org.codehaus.groovy, groovy-all, 1.7.2]
+licenses to remove from supplemental-models.xml (are spurious):
+[org.slf4j, slf4j-api, 1.5.2]
+</pre>
-ffda6510d6461f9b86dee513a96bdf4e
+<p>If any missing entries are listed or are spurious, then update
<code>supplemental-models.xml</code> and try again.</p>
+<p><div class="note">
+Ignore any missing license warnings for the TCK modules; this is a result of
the TCK modules for the viewers (eg <code>bdd-concordion-tck</code>) depending
on the TCK dom, fixtures etc.
+</div></p>
+<h2>Preparing a Release (<code>mvn release:prepare</code>)</h2>
-In order to prepare a release, you must have a public/private key pair, and
have configured Maven. See the page on [key generation](key-generation.html)
for more details.
+<p>In order to prepare a release, you must have a public/private key pair, and
have configured Maven. See the page on <a href="key-generation.html">key
generation</a> for more details.</p>
-<div class="note">
+<p><div class="note">
... in progress ...
-</div>
-
-
-
-c423b6c57f2041040d02abccfc2311ee
-
-
-
-
-
-
-
-
-0cbfdf1a807891dadd49110917377fea
-
-
-
-
-
-8163c884bbeef87b4ce6775aa603b3bd
-
-
-
-All JIRA tickets for the release should be closed, or moved to future releases
if not yet addressed.
-
-
-
-e0f6a94b3e339b1123b033c2565ffb69
-
-
-
-For the completed release, use JIRA to generate release notes using the
procedure documented
[here](http://confluence.atlassian.com/display/JIRA/Creating+Release+Notes).
If any of the tickets closed are tasks/subtasks, then please edit the contents
of the file to associate them back together again.
-
-Then, update the appropriate section of the CMS site:
+</div></p>
+<pre>
+git checkout
+</pre>
+<h2>Post-Release</h2>
-bdca17d6020c21a5dbabfbc9c140ca8f
+<h3>Close All JIRA tickets for the release</h3>
+<p>All JIRA tickets for the release should be closed, or moved to future
releases if not yet addressed.</p>
+<h3>Update CMS site with release notes</h3>
+<p>For the completed release, use JIRA to generate release notes using the
procedure documented <a
href="http://confluence.atlassian.com/display/JIRA/Creating+Release+Notes";>here</a>.
If any of the tickets closed are tasks/subtasks, then please edit the
contents of the file to associate them back together again.</p>
-a5d4ee3b87b68e98b3a01ddfe2f28406
+<p>Then, update the appropriate section of the CMS site:</p>
+<ul>
+<li>on the <a href="../documentation.html">documentation page</a> clearly
indicate the latest version of the core or component just released</li>
+<li>a the core or component's about page, provide a link to release notes
providing details of the contents of the release.</li>
+</ul>
+<h3>Update <code>STATUS</code> file</h3>
-The trunk holds a
[STATUS](https://git-wip-us.apache.org/repos/asf/isis/repo?p=isis.git;a=blob_plain;f=STATUS;hb=HEAD)
file which is a brief summary of the current status of the project. Update
this file with details of the release.
+<p>The trunk holds a <a
href="https://git-wip-us.apache.org/repos/asf/isis/repo?p=isis.git;a=blob_plain;f=STATUS;hb=HEAD";>STATUS</a>
file which is a brief summary of the current status of the project. Update
this file with details of the release.</p>
<!--
DEFUNCT
Modified: websites/staging/isis/trunk/content/contributors/release-snapshot.html
==============================================================================
--- websites/staging/isis/trunk/content/contributors/release-snapshot.html
(original)
+++ websites/staging/isis/trunk/content/contributors/release-snapshot.html Mon
Dec 10 12:24:12 2012
@@ -184,6 +184,10 @@
</h1>
</div>
+<p><div class="stub">
+This page is a work-in-progress; it needs to be updated with respect to the <a
href="release-process.html">release process</a> for multiple releasable modules.
+</div></p>
+
<p>The only prerequisites for performing a release is that the contributor has
configured their environment. This involves updating your
<code>~/.m2/settings.xml</code> file:</p>
<pre>
Modified: websites/staging/isis/trunk/content/documentation.html
==============================================================================
--- websites/staging/isis/trunk/content/documentation.html (original)
+++ websites/staging/isis/trunk/content/documentation.html Mon Dec 10 12:24:12
2012
@@ -233,14 +233,14 @@
<ul>
<li><a href="contributors/using-git.html">Using Git</a></li>
<li><a href="contributors/git-workflow.html">Git Workflow</a></li>
-<li><a href="contributors/coding-conventions.html">Coding Conventions</a>
[stub]</li>
+<li><a href="contributors/coding-conventions.html">Coding Conventions</a></li>
</ul>
<h3>Committers</h3>
<ul>
<li><a href="contributors/updating-the-cms-site.html">Updating the CMS
site</a></li>
-<li><a href="contributors/release-snapshot.html">Release snapshot</a></li>
+<li><a href="contributors/release-snapshot.html">Release snapshot</a>
[wip]</li>
<li><a href="contributors/release-process.html">Release process</a> [wip]</li>
<li><a href="contributors/key-generation.html">Key Generation</a>
</div>
