TeamCity (Fake)

TeamCity Module

Namespace: Fake.BuildServer
Assembly: Fake.BuildServer.TeamCity.dll

Native support for TeamCity specific APIs.

The general documentation on how to use CI server integration can be found here. This module does not provide any special APIs please use FAKE APIs and they should integrate into this CI server. If some integration is not working as expected or you have features you would like to use directly please open an issue. For more information on TeamCity interaction from build scripts see here

Types

Type	Description
BuildParameters	TeamCity build parameters See Predefined Build Parameters documentation for more information
Environment	Exported environment variables during build. See the official documentation for details.
FileChange	Describe a change between builds
FileChangeType	The type of change that occured

Functions and values

Function or value	Description
`TeamCity.block name description` Full Usage: `TeamCity.block name description` Parameters: name : `string` description : `string` Returns: `IDisposable`	Open Named Block that will be closed when the block is disposed Usage: use __ = TeamCity.block "My Block" name : `string` description : `string` Returns: `IDisposable`
`TeamCity.reportBuildProblem message` Full Usage: `TeamCity.reportBuildProblem message` Parameters: message : `string`	Reports build problem message : `string`
`TeamCity.reportBuildStatus status message` Full Usage: `TeamCity.reportBuildStatus status message` Parameters: status : `string` message : `string`	Reports the build status. status : `string` message : `string`
`TeamCity.reportProgress message` Full Usage: `TeamCity.reportProgress message` Parameters: message : `string`	Reports the progress. message : `string`
`TeamCity.reportProgressFinish message` Full Usage: `TeamCity.reportProgressFinish message` Parameters: message : `string`	Reports the progress end. message : `string`
`TeamCity.reportProgressStart message` Full Usage: `TeamCity.reportProgressStart message` Parameters: message : `string`	Reports the progress start. message : `string`
`TeamCity.sendTeamCityError error` Full Usage: `TeamCity.sendTeamCityError error` Parameters: error : `string`	Sends an error to TeamCity error : `string`
`TeamCity.setBuildStatistic key value` Full Usage: `TeamCity.setBuildStatistic key value` Parameters: key : `string` value : `string`	Reports a build statistic. key : `string` value : `string`
`TeamCity.setParameter name value` Full Usage: `TeamCity.setParameter name value` Parameters: name : `string` value : `string`	Reports a parameter value name : `string` value : `string`