PR: MPCRUISECONTROL-30
Add missing documentation for several properties. git-svn-id: https://svn.apache.org/repos/asf/maven/maven-1/plugins/trunk@396704 13f79535-47bb-0310-9956-ffa450edef68
This commit is contained in:
ltheussl
@@ -17,6 +17,7 @@
|
||||
# Location where the CruiseControl configuration file will be generated.
|
||||
maven.cruisecontrol.build.dir = ${maven.build.dir}/cruisecontrol
|
||||
maven.cruisecontrol.config = ${maven.cruisecontrol.build.dir}/config.xml
|
||||
#maven.cruisecontrol.home=
|
||||
|
||||
# Properties that are used for generating the content of the CC config file
|
||||
# -------------------------------------------------------------------------
|
||||
@@ -63,7 +64,7 @@ maven.cruisecontrol.mail.spamwhilebroken=false
|
||||
maven.cruisecontrol.mail.usemap=true
|
||||
maven.cruisecontrol.mail.buildresultsurl=${maven.cruisecontrol.buildresults.url}
|
||||
maven.cruisecontrol.mail.css=${maven.cruisecontrol.home}/reporting/jsp/webcontent/css/cruisecontrol.css
|
||||
maven.cruisecontrol.mail.xlsdir=${maven.cruisecontrol.home}/reporting/jsp/webcontent/xsl
|
||||
maven.cruisecontrol.mail.xsldir=${maven.cruisecontrol.home}/reporting/jsp/webcontent/xsl
|
||||
maven.cruisecontrol.mail.failureaddress=${pom.build.nagEmailAddress}
|
||||
maven.cruisecontrol.mail.successaddress=${pom.build.nagEmailAddress}
|
||||
maven.cruisecontrol.mail.maps=
|
||||
|
||||
@@ -140,7 +140,7 @@
|
||||
spamwhilebroken="${maven.cruisecontrol.mail.spamwhilebroken}"
|
||||
logdir="${maven.cruisecontrol.logs.dir}/${pom.artifactId}"
|
||||
css="${maven.cruisecontrol.mail.css}"
|
||||
xsldir="${maven.cruisecontrol.mail.xlsdir}">
|
||||
xsldir="${maven.cruisecontrol.mail.xsldir}">
|
||||
<j:set var="usemap" value="${maven.cruisecontrol.mail.usemap}"/>
|
||||
<j:if test="${usemap == 'true'}">
|
||||
<!-- need to map ids to emails here -->
|
||||
|
||||
@@ -26,6 +26,7 @@
|
||||
</properties>
|
||||
<body>
|
||||
<release version="1.8-SNAPSHOT" date="In SVN">
|
||||
<action dev="ltheussl" type="fix" issue="MPCRUISECONTROL-30">Add missing documentation for several properties.</action>
|
||||
<action dev="ltheussl" type="fix" issue="MPCRUISECONTROL-29">Default for <code>maven.cruisecontrol.logs.mergedirectory</code> is incorrect on the Properties page.</action>
|
||||
<action dev="ltheussl" type="fix" issue="MPCRUISECONTROL-33">Property <code>maven.cruisecontrol.goals</code> contains deprecated <code>scm:update-project</code>.</action>
|
||||
<action dev="aheritier" type="update" issue="MAVEN-1712">Update dependencies to match ones in maven 1.1 core and to unify them between plugins. The following dependencies are updated :
|
||||
|
||||
@@ -28,12 +28,20 @@
|
||||
<th>Optional?</th>
|
||||
<th>Description</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.cruisecontrol.build.dir</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
The cruisecontrol build directory.
|
||||
Default value is <code>${maven.build.dir}/cruisecontrol</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.cruisecontrol.config</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Config file to update/create.
|
||||
Default value is <code>${maven.build.dir}/cruisecontrol/config.xml</code>.
|
||||
Default value is <code>${maven.cruisecontrol.build.dir}/config.xml</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -67,6 +75,14 @@
|
||||
Default value is <code>${maven.cruisecontrol.work.dir}/logs</code>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.cruisecontrol.mavenhome</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
The home directory of your Maven installation.
|
||||
Default value is <code>${maven.home}</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.cruisecontrol.schedule.type</td>
|
||||
<td>Yes</td>
|
||||
@@ -117,6 +133,14 @@
|
||||
<code>${maven.cruisecontrol.checkout.dir}/${pom.artifactId}/${maven.build.dir}/test-reports</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.cruisecontrol.logs.pattern</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
The pattern of files to merge.
|
||||
Default value is <code>TEST-*.xml</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.cruisecontrol.currentbuildstatus.filename</td>
|
||||
<td>Yes</td>
|
||||
@@ -138,6 +162,7 @@
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
Template file to use in generating the cruisecontrol.xml file.
|
||||
Default value is <code>${plugin.resources}/cruisecontrol.jsl</code>.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -228,6 +253,16 @@
|
||||
<code>always</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.cruisecontrol.mail.spamwhilebroken</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>
|
||||
Whether or not e-mail reports on failed builds will continue for subsequent failed builds.
|
||||
Default value is <code>false</code>.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.cruisecontrol.mail.defaultsuffix</td>
|
||||
<td>Yes</td>
|
||||
@@ -236,6 +271,69 @@
|
||||
<code>${pom.build.nagEmailAddress}</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.cruisecontrol.mail.buildresultsurl</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>
|
||||
URL to the build results JSP.
|
||||
Default value is <code>${maven.cruisecontrol.buildresults.url}</code>.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.cruisecontrol.mail.css</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>
|
||||
Path to cruisecontrol.css.
|
||||
Default value is <code>${maven.cruisecontrol.home}/reporting/jsp/webcontent/css/cruisecontrol.css</code>.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.cruisecontrol.mail.xsldir</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>
|
||||
Directory where standard CruiseControl xsl files are located.
|
||||
Default value is <code>${maven.cruisecontrol.home}/reporting/jsp/webcontent/xsl</code>.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.cruisecontrol.mail.failureaddress</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>
|
||||
Mail address to be emailed notification after failed builds.
|
||||
Default value is <code>${pom.build.nagEmailAddress}</code>.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.cruisecontrol.mail.successaddress</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>
|
||||
Mail address to be emailed notification after successful builds.
|
||||
Default value is <code>${pom.build.nagEmailAddress}</code>.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>maven.cruisecontrol.mail.maps</td>
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>
|
||||
Maps a source control user id to an email address.
|
||||
Given by a comma-separated list of aliases, each of which
|
||||
should be accompanied by an address of the form
|
||||
<code>maven.cruisecontrol.mail.map.${alias}</code>.
|
||||
Default value is the empty string.
|
||||
</p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</section>
|
||||
<section name="Maven Cruise Control Plug-in Jabber Settings">
|
||||
@@ -345,7 +443,7 @@
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>Base directory in the FTP server to put the files. Default value is
|
||||
<code>.</code>.</p>
|
||||
'<code>.</code>'.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -445,7 +543,7 @@
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>The directory to copy from. Default value is
|
||||
<code>${maven.cruisecontrol.logs.dir}</code>.</p>
|
||||
<code>${maven.cruisecontrol.logs.dir}/${pom.artifactId}</code>.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -473,7 +571,7 @@
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>The directory to copy the log files. Default value is
|
||||
<code>.</code>.</p>
|
||||
'<code>.</code>'.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
@@ -481,7 +579,7 @@
|
||||
<td>Yes</td>
|
||||
<td>
|
||||
<p>The directory to copy the currentstatusfile. Default value is
|
||||
<code>.</code>.</p>
|
||||
'<code>.</code>'.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
||||
Reference in New Issue
Block a user