FinalBuilder Task¶
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 (http://www.finalbuilder.com/finalbuilder.aspx).
Version¶
Available from version 1.3
Examples¶
Minimalist example
1<FinalBuilder>
2 <ProjectFile>C:\Projects\BuildProject\Build Process.fbz5</ProjectFile>
3</FinalBuilder>Full example
1<FinalBuilder>
2 <ProjectFile>C:\Projects\BuildProject\Build Process.fbz5</ProjectFile>
3 <FBVersion>5</FBVersion>
4 <ShowBanner>false</ShowBanner>
5 <FBVariables>
6 <FBVariable name="IsContinuousIntegrationBuild" value="True" />
7 </FBVariables>
8 <Timeout>3600</Timeout>
9 <DontWriteToLog>true</DontWriteToLog>
10</FinalBuilder>Configuration Elements¶
| Element | Description | Type | Required | Default | Version |
| description | Description used for the visualisation of the buildstage, if left empty the process name will be shown. | String | No | The task/publisher name. | 1.5 |
| DontWriteToLog | Disable output to the FinalBuilder project log file. | Boolean | No | false | 1.3 |
| dynamicValues | The dynamic values to use for the task. | Dynamic Values array | No | None | 1.5 |
| environment | A set of environment variables set for commands that are executed. Each variable should be specified as . |
Environment Variable array | No | ||
| FBCMDPath | The absolute path to FBCMD.EXE. If this value is not set, then the value will be generated using either FBVersion or the project file. |
String | No | Generated | 1.3 |
| FBVariables | One or more FBVariable elements to pass to FinalBuilder. | FBVariable array | No | None | 1.3 |
| 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.) If this element is not specified, the FinalBuilder version is determined automatically from the project file name (recommended.) |
Int32 | No | Generated | 1.3 |
| ProjectFile | The full path of the FinalBuilder project to run. | String | Yes | n/a | 1.3 |
| ShowBanner | Specify 'true' to enable the "banner" at the top of the FinalBuilder console output. | Boolean | No | false | 1.3 |
| Timeout | The number of seconds to wait before assuming that the FinalBuilder project has hung and should be killed. | Int32 | No | 0 | 1.3 |
| UseTemporaryLogFile | Log to a temporary log file which is deleted when the project closes. Overrides DontWriteToLog. 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. |
Boolean | No | false | 1.3 |
Notes¶
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 and 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.
Integration Properties¶
| Label | Description | Example | Version |
| CCNetArtifactDirectory | The project artifact directory (as an absolute path) | C:\Program Files\CruiseControl.NET\Server\MyProject\Artifacts | 1.0 |
| 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 | 1.0 |
| CCNetBuildDate | The date of the build (in yyyy-MM-dd format) | 2005-08-10 | 1.0 |
| CCNetBuildTime | The time of the start of the build (in HH:mm:ss format) | 08:45:12 | 1.0 |
| CCNetFailureTasks | The list of name of tasks which have contributed to the current build failure. When the description of the task is filled in, this will be shown. | Exec Task | 1.7 |
| CCNetFailureUsers | The list of users who have contributed modifications to a sequence of builds that has failed. | John, Smith | 1.0 |
| CCNetIntegrationStatus | The status of the current integration. Could be Success, Failure, Exception or Unknown | Success | 1.0 |
| CCNetLabel | The label used to identify the CCNet build. This label is generated by the CCNet labeller. | 1.0.2.120 | 1.0 |
| CCNetLastIntegrationStatus | The status of the previous integration. Could be Success, Failure, Exception or Unknown | Success | 1.0 |
| CCNetListenerFile | View build progress : task output that shows how far the build is | c:\Project\Artifact\listener.xml | 1.4.0 |
| CCNetModifyingUsers | The list of users who have contributed to the current build only | Smith | 1.0 |
| CCNetNumericLabel | Contains the label as an integer if conversion is possible, otherwise zero. | 1 | 1.0 |
| CCNetProject | The name of the CCNet project that is being integrated. | MyProject | 1.0 |
| CCNetProjectUrl | The URL where the project is located | http://myhost/ccnet/server/ | 1.0 |
| CCNetRequestSource | The source of the integration request; this will generally be the name of the trigger that raised the request. | IntervalTrigger | 1.1.0 |
| 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 |
| CCNetWorkingDirectory | The project working directory (as an absolute path) | C:\Program Files\CruiseControl.NET\Server\MyProject\WorkingDirectory | 1.0 |
Automatically Generated¶
Documentation generated on Monday, 26 May 2014 at 7:18:04 AM