INFO

This API documentation is for FAKE version 5.0 or later. The old API documentation can be found here for migration or here for fake 4

This is part of the Fake.BuildServer.TeamCity module.

TeamCity

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

Nested types and modules

TypeDescription
BuildParameters

TeamCity build parameters

See Predefined Build Parameters documentation for more information

Environment
FileChange

Describe a change between builds

FileChangeType

The type of change that occured

Functions and values

Function or valueDescription
TeamCity.block name description
Signature: name:string -> description:string -> IDisposable

Open Named Block that will be closed when the block is disposed Usage: use __ = TeamCity.block "My Block"

TeamCity.defaultTraceListener
Signature: ITraceListener
TeamCity.detect()
Signature: unit -> bool
TeamCity.install(force)
Signature: force:bool -> unit
TeamCity.Installer
Signature: BuildServerInstaller
TeamCity.reportBuildProblem(message)
Signature: message:string -> unit

Reports build problem

TeamCity.reportBuildStatus(...)
Signature: status:string -> message:string -> unit

Reports the build status.

TeamCity.reportProgress(message)
Signature: message:string -> unit

Reports the progress.

TeamCity.reportProgressFinish(message)
Signature: message:string -> unit

Reports the progress end.

TeamCity.reportProgressStart(message)
Signature: message:string -> unit

Reports the progress start.

TeamCity.sendTeamCityError(error)
Signature: error:string -> unit

Sends an error to TeamCity

TeamCity.setBuildStatistic key value
Signature: key:string -> value:string -> unit

Reports a build statistic.

TeamCity.setParameter name value
Signature: name:string -> value:string -> unit

Reports a parameter value