Author: sebb
Date: Sat Jan 10 23:06:33 2015
New Revision: 1650825
URL: http://svn.apache.org/r1650825
Log:
Update description for CP 36
Modified:
commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml
Modified: commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml
URL:
http://svn.apache.org/viewvc/commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml?rev=1650825&r1=1650824&r2=1650825&view=diff
==============================================================================
--- commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml (original)
+++ commons/cms-site/trunk/content/xdoc/commons-parent-pom.xml Sat Jan 10
23:06:33 2015
@@ -106,6 +106,11 @@
<strong><a href="#Java_Version">Java Version</a></strong> -
<code>source</code> and <code>target</code>
options can be configured through <i>properties</i> and
<i>profiles</i> are provided to test on
different Java versions.
+ Where necessary, plugins are down-graded to the latest version
that runs on earlier JVMs.
+ </li>
+ <li>
+ <strong><a href="#Testing Coverage">Testing Coverage</a></strong>
- both <code>Jacoco</code> and <code>Cobertura</code>
+ are supported. These can be independently enabled.
</li>
</ul>
</subsection>
@@ -114,7 +119,7 @@
<p>
The following is a list of the main <i>release</i> features provided
by
<a
href="http://svn.apache.org/repos/asf/commons/proper/commons-parent/trunk/pom.xml";>commons-parent</a>
- through the <a href="#rc_profile">rc</a> and <a
href="#release_profile">release</a> profiles.
+ through the <a href="#release_profile">release</a> profile.
</p>
<ul>
<li>
@@ -173,6 +178,23 @@
<li><strong>Surefire Report</strong></li>
<li><strong>Javadocs</strong></li>
<li><strong>Source Cross Reference</strong></li>
+ The pom excludes Maven defaults such as the <code>license</code>
report which is against the ASF branding rules.
+ The following are currently included by default (components can
add extra ones if they wish, but cannot remove them).
+ <ul>
+ <li><code>index</code></li>
+ <li><code>summary</code></li>
+ <li><code>modules</code></li>
+ <li><code>project-team</code></li>
+ <li><code>scm</code></li>
+ <li><code>issue-tracking</code></li>
+ <li><code>mailing-list</code></li>
+ <li><code>dependency-info</code></li>
+ <li><code>dependency-management</code></li>
+ <li><code>dependencies</code></li>
+ <li><code>dependency-convergence</code></li>
+ <li><code>cim</code></li>
+ <li><code>distribution-management</code></li>
+ </ul>
</ul>
</li>
<li>
@@ -399,29 +421,23 @@
</p>
</subsection>
- <subsection name="rc profile">
- <p>
- <a
href="http://svn.apache.org/repos/asf/commons/proper/commons-parent/trunk/pom.xml";>commons-parent</a>
- contains an <code>rc</code> profile for producing <i>release
candidates</i>.
- </p>
-
+ <subsection name="jacoco profile">
<p>
- Running the following command will, in addition to creating the jar
as normal, will also:
+ Enable this profile to run the Jacoco tool.
+ This requires at least Java 1.5.
+ The profile is not enabled by default.
+ If the file <code>src/site/resources/profile.jacoco</code> exists then
the profile is enabled.
+ This allows components to always enable the profile
</p>
- <ul>
- <li>produce the source and binary distributions</li>
- <li>produce the javadoc and sources jars</li>
- </ul>
-
- <source>mvn -Prc package</source>
+ </subsection>
+ <subsection name="covertura profile">
<p>
- Running the following command will, as well as doing producing
everything specified above for
- the <i>package</i> command, also sign the artifacts and create
checksums (in local m2 repo):
+ Enable this profile to run the Cobertura tool.
+ The profile is not enabled by default.
+ If the file <code>src/site/resources/profile.cobertura</code> exists
then the profile is enabled.
+ This allows components to always enable the profile
</p>
-
- <source>mvn -Prc install</source>
-
</subsection>
<subsection name="release profile">
@@ -476,36 +492,35 @@
<source>mvn -Ptrunks-proper clean test</source>
</subsection>
- <subsection name="trunks-sandbox profile">
+ <subsection name="release-notes profile">
<p>
- <a
href="http://svn.apache.org/repos/asf/commons/proper/commons-sandbox-parent/trunk/pom.xml";>commons-sandbox-parent</a>
- contains a <code>trunks-sandbox</code> profile with the <a
href="sandbox/index.html">sandbox components</a> set up
- as <code><modules></code>. This is a <i>convenience</i>
profile so that Maven commands can be run
- for all <a href="sandbox.html">sandbox components</a>.
+ This uses the <code>src/changes.xml</code> file to generate the file
<code>RELEASE-NOTES.txt</code>.
+ Requires file <code>src/changes/release-notes.vm</code>.
+ A sample template is available from:
+
https://svn.apache.org/repos/asf/commons/proper/commons-parent/trunk/src/changes/release-notes.vm
</p>
+ <source>mvn changes:announcement-generate -Prelease-notes
[-Dchanges.version=nnn]</source>
<p>
- <strong>N.B.</strong> This profile works with
- <a
href="http://svn.apache.org/repos/asf/commons/trunks-sandbox/";>http://svn.apache.org/repos/asf/commons/trunks-sandbox/</a>
- which, you need to check out first (it pulls in the <i>trunks</i> of
the <a href="sandbox/index.html">sandbox components</a>
- using an <code>svn:externals</code> property - see
- <a
href="http://svnbook.red-bean.com/en/1.1/svn-book.html#svn-ch-7-sect-2.3.6";>here</a>
for more details).
+ Defining changes.version allows one to create the RN without first
removing the SNAPSHOT suffix from the POM.
</p>
+ </subsection>
+ <subsection name="javasvn profile">
<p>
- For example, if the template for the
- <a
href="http://commons.apache.org/commons-build-plugin/sandbox-jira-page.html";>sandbox
issue tracking page</a>
- was changed, you could re-generate the issue tracking pages for all
<a href="sandbox.html">sandbox components</a>
- using the following command:
+ Optional profile to use javasvn instead of the SVN CLI for the
buildNumber plugin
</p>
+ </subsection>
- <source>mvn -Ptrunks-sandbox commons:sandbox-jira-page</source>
-
+ <subsection name="Other profiles, not intended for direct use">
<p>
- ...or to test all sandbox components:
+ The pom also includes some helper profiles that are automatically
enabled as needed
</p>
+ <li>
+ <ul><code>jdk7-findbugs</code> - updates Findbugs version for use
under JDK7</ul>
+ <ul><code>svn-buildnumber</code> - adds the build number to the
manifests; suppress with <source>-Dbuildnumber.skip</source></ul>
+ </li>
- <source>mvn -Ptrunks-sandbox clean test</source>
</subsection>
</section>
