The FinalBuilder Task allows you to invoke FinalBuilder build projects as part of a CruiseControl.NET integration project.

FinalBuilder is a commercial build and release management solution for Windows software developers and SCM professionals, developed and marketed by VSoft Technologies.

Configuration

In order to use the FinalBuilder Task, you will need a FinalBuilder installation co-existing on the same server as a CruiseControl.NET installation.

(Note: The FinalBuilder Task is only available as of CruiseControl.NET version 1.3.)

Examples

Minimalist example:

<FinalBuilder>
	<ProjectFile>C:\Projects\BuildProject\Build Process.fbz5</ProjectFile>
</FinalBuilder>

<FinalBuilder>
	<ProjectFile>C:\Projects\BuildProject\Build Process.fbz5</ProjectFile>
	<FBVersion>5</FBVersion>
	<ShowBanner>false</ShowBanner>
	<FBVariables>
		<FBVariable name="IsContinuousIntegrationBuild" value="True" />
	</FBVariables>
	<Timeout>3600</Timeout>
	<DontWriteToLog>true</DontWriteToLog>
</FinalBuilder>

Configuration Elements:

Node	Description	Type	Required	Default	Version
ProjectFile	The full path of the FinalBuilder project to run. This is the only required element.	string	true	n/a
FBVariables	A parent element for one or more FBVariable elements.	element	false
FBVariable	Specify a variable to set inside the FinalBuilder project at runtime ("name"), and a value to set ("value"). The variable should be defined in the project.	element	false
ShowBanner	Specify 'true' to enable the "banner" at the top of the FinalBuilder console output.	boolean	false	False.
Timeout	The number of seconds to wait before assuming that the FinalBuilder project has hung and should be killed.	int	false	0 (no timeout.)
DontWriteToLog	Disable output to the FinalBuilder project log file.	boolean	false	False.
UseTemporaryLogFile	Log to a temporary log file which is deleted when the project closes. Overrides DontWriteToLog.	boolean	false	False.
FBVersion	Use this element to explicitly specify a version of FinalBuilder to run (for instance, you could force a FinalBuilder 4 project to run in FinalBuilder 5.)	int	false	If this element is not specified, the FinalBuilder version is determined automatically from the project file name (recommended.)
description	If filled in, this will be shown in the buildstage as the process name	string	false	n/a
dynamicValues	Any dynamic parameters to be used. See Dynamic Parameters	Dynamic values array - see Dynamic Parameters	No	None	1.5.0

Use this option instead of DontWriteToLog if you still want to be able to use the Export Log action, but don't want the log file to be updated. This element is only available in CC.Net build 1.3.0.2800 and newer.

Integration Properties

The following integration properties are passed to FinalBuilder as environment variables:

Label	Description	Example	Version
CCNetBuildCondition	The condition used to trigger the build, indicating if the build was triggered by new modifications or if it was forced. Legal values are: "IfModificationExists" or "ForceBuild"	ForceBuild
CCNetIntegrationStatus	The status of the current integration. Could be Success, Failure, Exception or Unknown	Success
CCNetLabel	The label used to identify the CCNet build. This label is generated by the CCNet labeller.	1.0.2.120
CCNetLastIntegrationStatus	The status of the previous integration. Could be Success, Failure, Exception or Unknown	Success
CCNetProject	The name of the CCNet project that is being integrated.	MyProject
CCNetBuildDate	The date of the build (in yyyy-MM-dd format)	2005-08-10
CCNetBuildTime	The time of the start of the build (in HH:mm:ss format)	08:45:12
CCNetArtifactDirectory	The project artifact directory (as an absolute path)	c:\program files\CruiseControl.NET\Server\MyProject\Artifacts
CCNetWorkingDirectory	The project working directory (as an absolute path)	c:\program files\CruiseControl.NET\Server\MyProject\WorkingDirectory
CCNetRequestSource	The source of the integration request; this will generally be the name of the trigger that raised the request.	IntervalTrigger	1.1.0
CCNetFailureUsers	The list of users who have contributed modifications to a sequence of builds that has failed.	John, Smith
CCNetListenerFile	Viewing build progress with Nant and MSBuild	c:\Project\Artifact\listener.xml	1.4.0
CCNetProjectUrl	The URL where the project is located	http://myhost/ccnet/server/
CCNetNumericLabel	Contains the label as an integer if conversion is possible, otherwise zero.	1
CCNetModifyingUsers	The list of users who have contributed to the current build only	Smith
CCNetUser	The user who forced the build. If security is off, or the build is not forced, then this will not be set.	John Doe	1.5.0

Frequently Asked Questions

Can I format output to the CruiseControl.NET web dashboard?

At the moment, output from the FinalBuilder Task is plain text. We are planning to change this so that the task outputs XML which can be easily used with the various CruiseControl.NET publishers.

In the meantime, it is possible to use the FinalBuilder Export Log Action to export an XML file, which can then be incorporated via the File Merge Task.

Which FinalBuilder version do I need?

The task will work with FinalBuilder versions 3, 4, and 5. However, because the task uses the FBCMD command line utility, users of FinalBuilder 3 & 4 will need the Professional Edition. FinalBuilder 5 users can use either the Standard or Professional editions. A free 30 day trial download is available.