Force Builder Publisher

The ForceBuildPublisher forces a build on a local or remote build server. It uses .NET Remoting to invoke a forced build on the CruiseControl.NET server at the specified URI.

The forced build runs asynchronously, i.e. the ForceBuildPublisher does not wait for the forced build to finish. The ForceBuildPublisher is a great way to help Splitting the build .

An alternative to the ForceBuildPublisher is the Project Trigger. The main difference is that the ForceBuildPublisher is placed in the configuration for the primary project, while the ProjectTrigger is is placed in the configuration for the dependent project.

Version

Available from version 1.0

Examples

Simple Example

1<forcebuild>
2  <project>AcceptanceTestProject</project>
3  <serverUri>tcp://buildserver2:21234/CruiseManager.rem</serverUri>
4  <integrationStatus>Success</integrationStatus>
5  <enforcerName>Forcer</enforcerName>
6</forcebuild>

Example with Security

 1<forcebuild>
 2  <project>AcceptanceTestProject</project>
 3  <serverUri>tcp://buildserver2:21234/CruiseManager.rem</serverUri>
 4  <integrationStatus>Success</integrationStatus>
 5  <security>
 6    <namedValue name="username" value="autobuild" />
 7    <namedValue name="password" value="autobuild" />
 8  </security>
 9</forcebuild>

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
dynamicValues The dynamic values to use for the task. Dynamic Values array No None 1.5
enforcerName Identification of a ForceBuildPublisher. This value is passed to the CCNetRequestSource attribute of the forced project's build. String No BuildForcer 1.0
environment A set of environment variables set for commands that are executed.
Each variable should be specified as
1<variable name="name" value="value" />

.
Environment Variable array No
integrationStatus The condition determining whether or not the remoting call should be made. The default value is "Success" indicating that the specified build will be forced if the current build was successful String - one of:
* Success
* Failure
* Exception
* Unknown
* Cancelled
No Success 1.0
parameters The parameters to pass to the remote project. Named Value array No None 1.5
project The CCNet project to force build. String Yes n/a 1.0
security The security credentials to pass through to the remote server.
These are only needed if the remote project has security applied. If credentials are passed to the remote server, then the enforcerName will be ignored. Valid security tokens are: "username" and "password" (this list may be expanded in future).
Named Value array No None 1.5
serverUri The URI for the local or remote server managing the project to build. The default value is the default URI for the local build server.
This publisher only uses .NET Remoting for connecting to the remote server. As such, it cannot use the HTTP protocol for connecting.
String No tcp://localhost:21234/CruiseManager.rem 1.0

Automatically Generated

Documentation generated on Monday, 26 May 2014 at 7:18:00 AM