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

OBSOLETE

please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity instead

TeamCityHelper

Contains helper functions which allow FAKE to communicate with a TeamCity agent

Nested types and modules

Type	Description
TeamCityDotNetCoverageTool	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead

Module	Description
TeamCityBuildParameters	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.BuildParameters instead TeamCity build parameters See Predefined Build Parameters documentation for more information
TeamCityChangedFiles	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.ChangedFiles instead Get files changed between builds in TeamCity

Functions and values

Function or value	Description
`ComparisonFailure(...)` Signature: name:string -> message:string -> details:string -> expected:string -> actual:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead Reports a failed comparison.
`EncapsulateSpecialChars(text)` Signature: text:string -> string Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the Trace module instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the Trace module instead Encapsulates special chars
`FinishTestCase testCaseName duration` Signature: testCaseName:string -> duration:TimeSpan -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead Finishes the test case.
`FinishTestSuite(testSuiteName)` Signature: testSuiteName:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead Finishes the test suite.
`getTeamCityBranch()` Signature: unit -> string option Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.Branch instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.Branch instead Get the branch of the main VCS root
`getTeamCityBranchIsDefault()` Signature: unit -> bool Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.IsDefaultBranch instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.IsDefaultBranch instead Get if the current branch is the one configured as default
`getTeamCityBranchName()` Signature: unit -> string option Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.BranchDisplayName instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.BranchDisplayName instead Get the display name of the branch as shown in TeamCity See the documentation for more information
`getTeamCityRecentlyFailedTests()` Signature: unit -> seq<string> option Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.RecentlyFailedTests instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.RecentlyFailedTests instead Name of recently failing tests See the documentation for more information
`IgnoreTestCase name message` Signature: name:string -> message:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead Ignores the test case.
`IgnoreTestCaseWithDetails(...)` Signature: name:string -> message:string -> details:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead Ignores the test case.
`PublishArticfact(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead
`PublishArtifact(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Publishes an artifact on the TeamcCity build server.
`ReportBuildStatus status message` Signature: status:string -> message:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.<> instead Reports the build status.
`ReportProgress(message)` Signature: message:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.<> instead Reports the progress.
`ReportProgressFinish(message)` Signature: message:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.<> instead Reports the progress end.
`ReportProgressStart(message)` Signature: message:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.<> instead Reports the progress start.
`scrub` Signature: string -> string Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the Trace module instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the Trace module instead
`sendCloseBlock` Signature: string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the TeamCity.block instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the TeamCity.block instead Close Named Block
`sendOpenBlock` Signature: string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the TeamCity.block instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the TeamCity.block instead Open Named Block
`sendStrToTeamCity(s)` Signature: s:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the Trace module instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the Trace module instead Send message to TeamCity
`sendTeamCityCheckstyleImport(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an Checkstyle results filename to TeamCity
`sendTeamCityDotCoverHome` Signature: string -> unit	Sends the full path to the dotCover home folder to override the bundled dotCover to TeamCity
`sendTeamCityDotNetCoverageImport(path)` Signature: path:string -> unit Attributes: [<Obsolete("This function does not specify the type of coverage tool used to generate the report. Use 'sendTeamCityDotNetCoverageImportForTool' instead")>]	OBSOLETE This function does not specify the type of coverage tool used to generate the report. Use 'sendTeamCityDotNetCoverageImportForTool' instead Sends an dotcover, partcover, ncover or ncover3 results filename to TeamCity
`sendTeamCityDotNetCoverageImportForTool(...)` Signature: path:string -> tool:TeamCityDotNetCoverageTool -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an dotcover, partcover, ncover or ncover3 results filename to TeamCity
`sendTeamCityDotNetDupFinderImport(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an ReSharper dupfinder.exe results filename to TeamCity
`sendTeamCityError(error)` Signature: error:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the TeamCity.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the TeamCity.<> instead Sends an error to TeamCity
`sendTeamCityFindBugsImport(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an FindBugs results filename to TeamCity
`sendTeamCityFxCopImport(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an FxCop inspection results filename to TeamCity
`sendTeamCityFXCopImport(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an FXCop results filename to TeamCity
`sendTeamCityGTestImport(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an Google Test results filename to TeamCity
`sendTeamCityJSLintImport(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an JSLint results filename to TeamCity
`sendTeamCityJUnitImport(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an JUnit Ant task results filename to TeamCity
`sendTeamCityMSTestImport(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an MSTest results filename to TeamCity
`sendTeamCityNCover3Home` Signature: string -> unit	Sends the full path to NCover installation folder to TeamCity
`sendTeamCityNCover3ReporterArgs` Signature: string -> unit	Sends arguments for the NCover report generator to TeamCity
`sendTeamCityNCoverExplorerTool` Signature: string -> unit	Sends the path to NCoverExplorer to TeamCity
`sendTeamCityNCoverExplorerToolArgs` Signature: string -> unit	Sends additional arguments for NCover 1.x to TeamCity
`sendTeamCityNCoverReportOrder` Signature: int -> unit	Sends the value for NCover /sort: argument to TeamCity
`sendTeamCityNCoverReportType` Signature: int -> unit	Sends the value for NCover /report: argument to TeamCity
`sendTeamCityNUnitImport(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an NUnit results filename to TeamCity
`sendTeamCityPartCoverReportXslts` Signature: seq<string * string> -> unit	Send the PartCover xslt transformation rules (Input xlst and output files) to TeamCity
`sendTeamCityPmdCpdImport(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an PMD Copy/Paste Detector results filename to TeamCity
`sendTeamCityPmdImport(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an PMD inspections results filename to TeamCity
`sendTeamCityReSharperInspectCodeImport(...)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an ReSharper inspectCode.exe results filename to TeamCity
`sendTeamCitySurefireImport(path)` Signature: path:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.publish instead Sends an Maven Surefire results filename to TeamCity
`sendToTeamCity format message` Signature: format:StringFormat<(string -> string)> -> message:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the Trace module instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the Trace module instead Send message to TeamCity
`SetBuildNumber(buildNumber)` Signature: buildNumber:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.setBuildNumber instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.setBuildNumber instead Sets the TeamCity build number.
`SetBuildStatistic key value` Signature: key:string -> value:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.<> instead Reports a build statistic.
`SetTeamCityParameter name value` Signature: name:string -> value:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.<> instead Reports a parameter value
`StartTestCase(testCaseName)` Signature: testCaseName:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead Starts the test case.
`StartTestSuite(testSuiteName)` Signature: testSuiteName:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead Starts the test suite.
`teamCityBlock(name)` Signature: name:string -> IDisposable Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the TeamCity.block instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use the TeamCity.block instead Open Named Block that will be closed when the block is disposed Usage: `use __ = teamCityBlock "My Block"`
`TeamCityBuildConfigurationName` Signature: string option Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.BuildConfigurationName instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.BuildConfigurationName instead The Name of the Build Configuration the current build belongs to or None if it's not on TeamCity.
`TeamCityBuildIsPersonal` Signature: bool Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.BuildIsPersonal instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.BuildIsPersonal instead Is set to true if the build is a personal one.
`TeamCityBuildNumber` Signature: string option Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.BuildNumber instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.BuildNumber instead The Build number assigned to the build by TeamCity using the build number format or None if it's not on TeamCity.
`TeamCityProjectName` Signature: string option Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.ProjectName instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.ProjectName instead The Name of the project the current build belongs to or None if it's not on TeamCity.
`TeamCityVersion` Signature: string option Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.Version instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use TeamCity.Environment.Version instead The Version of the TeamCity server. This property can be used to determine the build is run within TeamCity.
`TestFailed name message details` Signature: name:string -> message:string -> details:string -> unit Attributes: [<Obsolete("please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead")>]	OBSOLETE please use nuget 'Fake.BuildServer.TeamCity', open Fake.BuildServer and use Trace.<> instead Reports a failed test.