diff --git a/cruisecontrol/project.xml b/cruisecontrol/project.xml index 0122459c..0e17cd82 100644 --- a/cruisecontrol/project.xml +++ b/cruisecontrol/project.xml @@ -23,7 +23,7 @@ maven-cruisecontrol-plugin Maven Cruise Control Plugin 1.5-SNAPSHOT - A plugin to handle the generating and maintaining of Cruise Control configuration. Requires Maven 1.0 RC2. + A plugin to handle the generating and maintaining of Cruise Control configuration. Requires Maven 1.0. Cruise Control Plugin for Maven http://maven.apache.org/reference/plugins/cruisecontrol/ http://jira.codehaus.org/browse/MPCRUISECONTROL diff --git a/cruisecontrol/xdocs/faq.fml b/cruisecontrol/xdocs/faq.fml index 63c21976..1718d0b2 100644 --- a/cruisecontrol/xdocs/faq.fml +++ b/cruisecontrol/xdocs/faq.fml @@ -84,6 +84,61 @@ maven.cruisecontrol.template=${plugin.resources}/my-cc-template.jsl]]> + + + How do I setup my project to be built using Cruise Control? + + + + + + + + + How often should I update the CruiseControl configuration file? + + + Since there is limited information in the file, not very often. You + should regenerate the file when: + + + + + + + Do I need to edit the CruiseControl configuration file? + + By default no, since much of the information in the file originates + in properties and project.xml. For changes that affect the generation + of the project or projects, you may want to create you own template. + If you have dependencies defined, then you need to ensure the order + of the projects in the file corresponds with the order the project + should be built. + + + diff --git a/cruisecontrol/xdocs/properties.xml b/cruisecontrol/xdocs/properties.xml index 34a2a1b7..31e282a0 100644 --- a/cruisecontrol/xdocs/properties.xml +++ b/cruisecontrol/xdocs/properties.xml @@ -35,6 +35,10 @@ No

Location of cruise control installation - for finding the reporting directory

+

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

@@ -51,6 +55,10 @@

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

@@ -67,6 +75,10 @@

Where to checkout/update code temporarily. Default value is ${basedir}/checkout.

+

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

@@ -75,6 +87,10 @@

Default value is ${maven.build.dir}/cc-logs.

+

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

@@ -91,6 +107,10 @@

Config file to update/create. Default value is ${basedir}/cruisecontrol.xml.

+

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

@@ -106,6 +126,10 @@ Yes

Template file to use in generating the cruisecontrol.xml file.

+

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

@@ -113,10 +137,16 @@ Yes

- List of projects that should trigger this project to build when + 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. +

@@ -125,9 +155,26 @@

The root of the cruisecontrol site used in generating the link to - CruiseControl. By default this is pom.url. While not required, + CruiseControl. By default this 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. +