Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

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

TeamCityTraceListener

Implements a TraceListener for TeamCity build servers.

See the documentation for more information

ModuleDescription
ChangedFiles
Import
RecentlyFailedTests

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.comparisonFailure(...)
Signature: name:string -> message:string -> details:string -> expected:string -> actual:string -> unit

Reports a failed comparison.

TeamCity.defaultTraceListener
Signature: ITraceListener
TeamCity.detect()
Signature: unit -> bool
TeamCity.error(message)
Signature: message:string -> unit

Sends an error message.

TeamCity.finishTestCase(...)
Signature: testCaseName:string -> duration:TimeSpan -> unit

Finishes the test case.

TeamCity.finishTestSuite(testSuiteName)
Signature: testSuiteName:string -> unit

Finishes the test suite.

TeamCity.ignoreTestCase name message
Signature: name:string -> message:string -> unit

Ignores the test case.

TeamCity.ignoreTestCaseWithDetails(...)
Signature: name:string -> message:string -> details:string -> unit

Ignores the test case.

TeamCity.install(force)
Signature: force:bool -> unit
TeamCity.Installer
Signature: BuildServerInstaller
TeamCity.publishArtifact(path)
Signature: path:string -> unit

Publishes an artifact on the TeamcCity build server.

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.reportTestError name output
Signature: name:string -> output:string -> unit

Report Standard-Error for a given test-case

TeamCity.reportTestOutput name output
Signature: name:string -> output:string -> unit

Report Standard-Output for a given test-case

TeamCity.sendTeamCityDotCoverHome
Signature: string -> unit

Sends the full path to the dotCover home folder to override the bundled dotCover to TeamCity

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

Sends an error to TeamCity

TeamCity.sendTeamCityImportData typ file
Signature: typ:string -> file:string -> unit
TeamCity.sendTeamCityNCover3Home
Signature: string -> unit

Sends the full path to NCover installation folder to TeamCity

TeamCity.sendTeamCityNCover3ReporterArgs
Signature: string -> unit

Sends arguments for the NCover report generator to TeamCity

TeamCity.sendTeamCityNCoverExplorerTool
Signature: string -> unit

Sends the path to NCoverExplorer to TeamCity

TeamCity.sendTeamCityNCoverExplorerToolArgs(...)
Signature: string -> unit

Sends additional arguments for NCover 1.x to TeamCity

TeamCity.sendTeamCityNCoverReportOrder
Signature: int -> unit

Sends the value for NCover /sort: argument to TeamCity

TeamCity.sendTeamCityNCoverReportType
Signature: int -> unit

Sends the value for NCover /report: argument to TeamCity

TeamCity.sendTeamCityPartCoverReportXslts(...)
Signature: seq<string * string> -> unit

Send the PartCover xslt transformation rules (Input xlst and output files) to TeamCity

TeamCity.setBuildNumber(buildNumber)
Signature: buildNumber:string -> unit

Sets the TeamCity build number.

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

TeamCity.startTestCase(testCaseName)
Signature: testCaseName:string -> unit

Starts the test case.

TeamCity.startTestSuite(testSuiteName)
Signature: testSuiteName:string -> unit

Starts the test suite.

TeamCity.testFailed name message details
Signature: name:string -> message:string -> details:string -> unit

Reports a failed test.

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

Sends a warning message.