Maven CruiseControl Plug-in Properties
Property Optional? Description
maven.cruisecontrol.config Yes Config file to update/create. Default value is ${maven.build.dir}/cruisecontrol/config.xml.
maven.cruisecontrol.home No Location where CC is installed. No default value.
maven.cruisecontrol.work.dir Yes Location of the CC work directory that will be used at runtime. Default value is ${maven.cruisecontrol.build.dir}.
maven.cruisecontrol.checkout.dir Yes Location where to checkout/update code at runtime. Default value is ${maven.cruisecontrol.work.dir}/checkout.
maven.cruisecontrol.logs.dir Yes Location where CC logs will be generated at runtime. Default value is ${maven.cruisecontrol.work.dir}/logs
maven.cruisecontrol.schedule.type Yes Defines the schedule type: interval or time. Default value is interval.
maven.cruisecontrol.schedule.interval Yes Seconds in between builds for this project. Default value is 300.
maven.cruisecontrol.schedule.time Yes Time when builds this project, in the form HHmm (execute every day). Default value is 1900.
maven.cruisecontrol.logs.encodingtype Yes Encoding type for logs files. Default value is ISO-8859-1.
maven.cruisecontrol.logs.merge Yes Set true if you want to add others reports files at the end of the Cruisecontrol report file. Default value is true.
maven.cruisecontrol.logs.mergedirectory Yes Directory containing .xml reports files to merge. Default value is ${maven.cruisecontrol.checkout.dir}/${module}/[maven.build.dir relative location]/test-reports.
maven.cruisecontrol.currentbuildstatus.filename Yes The filename to write the current build status. Default value is status.txt.
maven.cruisecontrol.goals Yes Default value is scm:update-project|clean test|site:deploy.
maven.cruisecontrol.template Yes Template file to use in generating the cruisecontrol.xml file.
maven.cruisecontrol.trigger.projects Yes 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.

NOTE: 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.

maven.cruisecontrol.buildresults.site Yes The root of the cruisecontrol site used in generating the link to CC Default value is ${pom.url}/cruisecontrol. While not required, typically you will need to set this.
maven.cruisecontrol.buildresults.url Yes

The url of the cruisecontrol site used in generating the link to CruiseControl. By default this is ${maven.cruisecontrol.site}/buildresults/${pom.artifactId}.

Note: 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.

maven.cruisecontrol.mail.host Yes

Default value is localhost.

NOTE: It may be more appropriate to set this in build.properties on the CruiseControl server since the value may differ from developer to developer.

maven.cruisecontrol.mail.subjectprefix Yes

Default value is [BUILD].

maven.cruisecontrol.mail.skipusers Yes

Controls if the users who made changes in this build get email. Default value is false.

maven.cruisecontrol.mail.usemap Yes

if true, puts developers email address (find in project.xml), so they can receive email if skipusers is false. Default value is true.

maven.cruisecontrol.mail.reportsuccess Yes

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 always.

maven.cruisecontrol.mail.defaultsuffix Yes

Default value is the domain name of the first email in ${pom.build.nagEmailAddress}.

maven.cruisecontrol.ftp.targetHost Yes

Host name of the FTP server.

NOTE: This property doesn't have any default value, a value is required if maven.cruisecontrol.currentbuildstatusftppublisher property or maven.cruisecontrol.ftppublisher property is set to true.

maven.cruisecontrol.ftp.targetUser Yes

The user used for logging into the FTP site. Default value is anonymous.

maven.cruisecontrol.ftp.targetPasswd Yes

The password used during FTP log in for the maven.cruisecontrol.ftp.targetUser. Default value is anonymous.

maven.cruisecontrol.ftp.targetPort Yes

Port number of the FTP server. Default value is 21.

maven.cruisecontrol.ftp.targetDir Yes

Base directory in the FTP server to put the files. Default value is ..

maven.cruisecontrol.ftp.targetSeparator Yes

Directory separator character used by the FTP server. Default value is /.

maven.cruisecontrol.currentbuildstatusftppublisher Yes

Copies the file containing the current build status in a remote directory onto the FTP server. Default value is false.

NOTE: To use this CruiseControl property you need to add this line currentbuildstatusftppublisher=net.sourceforge.cruisecontrol.publishers.CurrentBuildStatusFTPPublisher in the default-plugins.properties file before building CruiseControl (you can find it, in INSTALL_DIR/main/src/net/sourceforge/cruisecontrol/).

maven.cruisecontrol.currentbuildstatusftppublisher.file Yes

The filename to write.

NOTE: This property doesn't have any default value, a value is required if maven.cruisecontrol.currentbuildstatusftppublisher property is set to true.

maven.cruisecontrol.currentbuildstatusftppublisher.destDir Yes

The remote directory to write the file.

NOTE: This property doesn't have any default value, a value is required if maven.cruisecontrol.currentbuildstatusftppublisher property is set to true.

maven.cruisecontrol.ftppublisher Yes

Copies the XML log file from the build onto the FTP server. Default value is false.

NOTE: To use this CruiseControl property you need to add this line ftppublisher=net.sourceforge.cruisecontrol.publishers.FTPPublisher in the default-plugins.properties file before building CruiseControl (you can find it, in INSTALL_DIR/main/src/net/sourceforge/cruisecontrol/).

maven.cruisecontrol.ftppublisher.destDir Yes

The remote directory to publish the files.

NOTE: This property doesn't have any default value, a value is required if maven.cruisecontrol.ftppublisher property is set to true.

maven.cruisecontrol.ftppublisher.srcDir Yes

To publish the XML log file, this must be the same as maven.cruisecontrol.logs.dir. Default value is ${maven.cruisecontrol.logs.dir}.

maven.cruisecontrol.ftppublisher.deleteArtifacts Yes

If yes, then all files successfully sent to the FTP server will be deleted locally. Default value is no.

maven.cruisecontrol.scppublisher Yes

Copies the XML log file from the build with a SCP command onto a remote host. Default value is false.

maven.cruisecontrol.scp.sourcedir Yes

The directory to copy from. Default value is ${maven.cruisecontrol.logs.dir}.

maven.cruisecontrol.scp.targetuser Yes

Log in to the target machine as this user.

NOTE: This property doesn't have any default value, a value is required if maven.cruisecontrol.scppublisher property is set to true.

maven.cruisecontrol.scp.targethost Yes

SCP to this machine.

NOTE: This property doesn't have any default value, a value is required if maven.cruisecontrol.scppublisher property is set to true.

maven.cruisecontrol.scp.targetlogdir Yes

The directory to copy the log files. Default value is ..

maven.cruisecontrol.scp.targetstatusfiledir Yes

The directory to copy the currentstatusfile. Default value is ..

maven.cruisecontrol.scp.targetseparator Yes

The file separator on the target machine. Default value is /.

maven.cruisecontrol.scp.ssh Yes

The ssh application. Default value is ssh.

maven.cruisecontrol.scp.file Yes

The filename to copy. Default value is the current log file.

maven.cruisecontrol.scp.statusfile Yes

The statusfilename to copy. Default value is ${maven.cruisecontrol.currentbuildstatus.filename}.