By Jason Che-han Yip, jcyip@thoughtworks.com
Send questions to the users list, cruisecontrol-users@lists.sourceforge.net
Last modified: June 20, 2003
Commit the Hello World source files to your source control repository
There are example Ant build files provided for the various source control systems supported by CruiseControl. For convenience of modification, the properties are set at the top of the build file and referenced in the targets below. Any properties that need to be set will have a note in ALL CAPS. For example, at the top of cvs-build.xml, you should find:
<property name="cvs.repository" value="REPLACE WITH CVSROOT" /> <property name="cvs.package" value="REPLACE WITH CVS PACKAGE" />
There are sample CruiseControl config files provided for the various source control systems supported by CruiseControl. Any changes that need to be made will have a note in ALL CAPS. For example, within cvs-config.xml, you should find:
<cvs cvsroot="REPLACE WITH CVSROOT" /> ... <email mailhost="REPLACE WITH MAILHOST" returnaddress="REPLACE WITH RETURN EMAIL ADDRESS" defaultsuffix="" buildresultsurl="http://localhost:8080/buildservlet/BuildServlet"> <always address="REPLACE WITH BUILD MASTER EMAIL ADDRESS" /> <failure address="REPLACE WITH FAILURE EMAIL ADDRESS" /> </email>
NOTE: The log directory in the config file must be the same as specified in the web.xml for the web application.
More details on the config file can be found here
Edit the web.xml found in the CruiseControl reporting module. You will need to add the locations of the log directory and the current build file. These should be in the form of an absolute path.
Build the reporting module using the provided build script. You will be asked to provide the path for several things:
This should generate a cruisecontrol.war in the dist directory. Deploy this to a servlet engine (e.g., Tomcat).
Set CCDIR to the installation of the main CruiseControl app (e.g., c:\cruisecontrol\main). Use the provided cruiseControl.bat or cruiseControl.sh to run CruiseControl. Arguments are:
If the CruiseControl setup was successful, you should have received an e-mail with a link to a page that will be generated by the servlet.
NOTE: By modifying the config file to use a HTMLEmailPublisher instead of a LinkEmailPublisher, you can have the build results in the e-mail