Files
maven-plugins/cruisecontrol/xdocs/properties.xml
T

248 lines
8.6 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Copyright 2001-2004 The Apache Software Foundation.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-->
<document>
<properties>
<title>Maven Cruise Control Plug-in Properties</title>
</properties>
<body>
<section name="Maven Cruise Control Plug-in Settings">
<table>
<tr>
<th>Property</th>
<th>Optional?</th>
<th>Description</th>
</tr>
<tr>
<td>maven.cruisecontrol.home</td>
<td>No</td>
<td>
<p>Location of cruise control installation - for finding the reporting directory</p>
<p>
<strong>NOTE: </strong>It may be more appropriate to set this in build.properties
on the CruiseControl server since the value may differ from developer to developer.
</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.schedule.type</td>
<td>Yes</td>
<td>
<p>Defines the schedule type: interval or time. Default value is
<code>interval</code>.</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.schedule.interval</td>
<td>Yes</td>
<td>
<p>Seconds in between builds for this project. Default value is
<code>300</code>.</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.schedule.time</td>
<td>Yes</td>
<td>
<p>Time when builds this project, in the form HHmm (execute every day). Default value is
<code>1900</code>.</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.checkout.dir</td>
<td>Yes</td>
<td>
<p>Where to checkout/update code temporarily. Default value is
<code>${basedir}/checkout</code>.</p>
<p>
<strong>NOTE: </strong>It may be more appropriate to set this in build.properties
on the CruiseControl server since the value may differ from developer to developer.
</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.logs.encodingtype</td>
<td>Yes</td>
<td>
<p>Encoding type for logs files. Default value is
<code>ISO-8859-1</code>.</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.logs.dir</td>
<td>Yes</td>
<td>
<p>Default value is
<code>${maven.build.dir}/cc-logs</code>.</p>
<p>
<strong>NOTE: </strong>It may be more appropriate to set this in build.properties
on the CruiseControl server since the value may differ from developer to developer.
</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.logs.merge</td>
<td>Yes</td>
<td>
<p>Set true if you want to add others reports files at the end of the Cruisecontrol report file. Default value is
<code>true</code>.</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.logs.mergedirectory</td>
<td>Yes</td>
<td>
<p>Directory containing .xml reports files to merge. Default value is
<code>${maven.cruisecontrol.checkout.dir}/${module}/target/test-reports</code>.</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.goals</td>
<td>Yes</td>
<td>
<p>Default value is
<code>scm:update-project|clean test|site:deploy</code>.</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.config</td>
<td>Yes</td>
<td>
<p>Config file to update/create. Default value is
<code>${basedir}/cruisecontrol.xml</code>.</p>
<p>
<strong>NOTE: </strong>It may be more appropriate to set this in build.properties
on the CruiseControl server since the value may differ from developer to developer.
</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.mail.host</td>
<td>Yes</td>
<td>
<p>Default value is
<code>localhost</code>.</p>
<p>
<strong>NOTE: </strong>It may be more appropriate to set this in build.properties
on the CruiseControl server since the value may differ from developer to developer.
</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.mail.subjectprefix</td>
<td>Yes</td>
<td>
<p>Default value is
<code>[BUILD]</code>.</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.mail.skipusers</td>
<td>Yes</td>
<td>
<p>Controls if the users who made changes in this build get email. Default value is
<code>false</code>.</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.mail.usemap</td>
<td>Yes</td>
<td>
<p>if true, puts developers email address (find in project.xml), so they can receive email if skipusers is false. Default value is
<code>true</code>.</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.mail.reportsuccess</td>
<td>Yes</td>
<td>
<p>Valid values : always (mails results on every successful build), never(only mails on failed builds ), fixes(mails results only on the first successful build and the first successful build after a failed build). Default value is
<code>always</code>.</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.mail.defaultsuffix</td>
<td>Yes</td>
<td>
<p>Default value is the domain name of the first email in
<code>${pom.build.nagEmailAddress}</code>.</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.template</td>
<td>Yes</td>
<td>
<p>Template file to use in generating the cruisecontrol.xml file.</p>
<p>
<strong>NOTE: </strong>It may be more appropriate to set this in build.properties
on the CruiseControl server since the value may differ from developer to developer.
</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.trigger.projects</td>
<td>Yes</td>
<td>
<p>
A comma separated list of projects that should trigger this project to build when
they are built. Allows you to build a project whose dependencies
have changed.
</p>
<p>
<strong>NOTE: </strong>You may need to edit the config file to ensure that dependent
project appear prior to the project. This is because CruiseControl builds projects in
the order that appear in the config file. Failure to order the project properly may
results in continuious rebuilding of project and/or avoidable build failures.
</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.buildresults.site</td>
<td>Yes</td>
<td>
<p>
The root of the cruisecontrol site used in generating the link to
CruiseControl. By default this is
<code>${pom.url}/cruisecontrol</code>. While not required,
typically you will need to set this.
</p>
</td>
</tr>
<tr>
<td>maven.cruisecontrol.buildresults.url</td>
<td>Yes</td>
<td>
<p>
The url of the cruisecontrol site used in generating the link to
CruiseControl. By default this is
<code>${maven.cruisecontrol.site}/buildresults/${pom.artifactId}</code>.
</p>
<p>
<strong>Note: </strong>Since the cruisecontrol report is not one of the
defaults reports, you must add the cruisecontrol report to see a
link to the Cruise Control Build Results under Project Reports.
</p>
</td>
</tr>
</table>
</section>
</body>
</document>