Author: danhaywood
Date: Wed Nov 28 00:13:07 2012
New Revision: 1414477
URL: http://svn.apache.org/viewvc?rev=1414477&view=rev
Log:
isis site
Modified:
isis/site/trunk/content/contributors/release-process-rat-exclusions.md
isis/site/trunk/content/contributors/release-process.md
Modified: isis/site/trunk/content/contributors/release-process-rat-exclusions.md
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/release-process-rat-exclusions.md?rev=1414477&r1=1414476&r2=1414477&view=diff
==============================================================================
--- isis/site/trunk/content/contributors/release-process-rat-exclusions.md
(original)
+++ isis/site/trunk/content/contributors/release-process-rat-exclusions.md Wed
Nov 28 00:13:07 2012
@@ -14,9 +14,11 @@ The Isis parent `pom.xml` specifies the
<tr><td> </td><td>**/*.pdn</td><td>Paint.NET format</td></tr>
<tr><td>Data files</td><td>**/*.json</td><td>JSON (test) data</td></tr>
<tr><td> </td><td>**/isis.log</td><td>Isis' log file (byproduct of
tests)</td></tr>
+<tr><td> </td><td>**/datanucleus.log</td><td>DataNucleus' log file
(byproduct of bytecode enhancement during compilation)</td></tr>
<tr><td> </td><td>**/rat.txt</td><td>RAT's own audit file</td></tr>
<tr><td> </td><td>**/fixture-data</td><td>SQL Object Store fixture
data</td></tr>
<tr><td> </td><td>**/test.data</td><td>SQL Object Store fixture
data</td></tr>
+<tr><td> </td><td>**/hsql-db/**</td><td>SQL Object Store test
database</td></tr>
<tr><td> </td><td>**/xml/**/*.xml</td><td>XML Object Store fixture
data</td></tr>
<tr><td> </td><td>tmp/tests/*.xml</td><td>XML Object Store fixture
data</td></tr>
<tr><td> </td><td>tmp/ldap-conf/**</td><td>LDAP Security fixture
data</td></tr>
Modified: isis/site/trunk/content/contributors/release-process.md
URL:
http://svn.apache.org/viewvc/isis/site/trunk/content/contributors/release-process.md?rev=1414477&r1=1414476&r2=1414477&view=diff
==============================================================================
--- isis/site/trunk/content/contributors/release-process.md (original)
+++ isis/site/trunk/content/contributors/release-process.md Wed Nov 28 00:13:07
2012
@@ -96,39 +96,54 @@ The Isis parent `pom.xml` specifies the
To run the RAT tool, first clean up any generated artifacts:
<pre>
-mvn clean -P integration-tests
+mvn clean # clean up target directory
+mvn clean -P m2e # clean up target-ide directory
</pre>
Then, run the tool using:
<pre>
-mvn org.apache.rat:apache-rat-plugin:check
+mvn org.apache.rat:apache-rat-plugin:check -D rat.num=50
</pre>
+where `rat.num` property is set to a high figure, temporarily overriding the
default value of 0. (If this isn't overridden and there are licenses, then the
command will simply fail).
+
{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.
}
-All being well the command should succeed. If it does not, then review the
`rat.txt` file in the failing module's `target` directory. Missing license
notes are indicated using the key:
+All being well the command should succeed. If it does not, then review the
`rat.txt` files in the failing module's `target` directory. Missing license
notes are indicated using the key:
- `!???` identifies those files that are missing license notes
- `tests-common/*` and `tests/*` ignores certain test files
- `hsql-db` are generated HSQLDB directories
+You can collate these together using something like:
+<pre>
+for a in `find . -name rat.txt -print`; do grep -H '!???' $a; done
+</pre>
+
Investigate and fix any reported violations.
-You can use the groovy script `addmissinglicenses.groovy` to automatically
insert missing headers:
+You can use the groovy script `addmissinglicenses.groovy` to automatically
insert missing headers
+Dry run:
<pre>
groovy addmissinglicenses.groovy
</pre>
+or actually execute:
+<pre>
+groovy addmissinglicenses.groovy -x
+</pre>
+
The actual files checked are those with extensions specified in the line:
<pre>
def fileEndings = [".java", ".htm"]
</pre>
+
## Missing License Check
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.
