TeamCityHelper
Contains helper functions which allow FAKE to communicate with a TeamCity agent
Nested types and modules
| Type | Description |
| TeamCityDotNetCoverageTool |
| Module | Description |
| TeamCityBuildParameters |
TeamCity build parameters See Predefined Build Parameters documentation for more information |
| TeamCityChangedFiles |
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
|
Reports a failed comparison. |
EncapsulateSpecialChars(text)
Signature: text:string -> string
|
Encapsulates special chars |
FinishTestCase testCaseName duration
Signature: testCaseName:string -> duration:TimeSpan -> unit
|
Finishes the test case. |
FinishTestSuite(testSuiteName)
Signature: testSuiteName:string -> unit
|
Finishes the test suite. |
getTeamCityBranch()
Signature: unit -> string option
|
Get the branch of the main VCS root |
getTeamCityBranchIsDefault()
Signature: unit -> bool
|
Get if the current branch is the one configured as default |
getTeamCityBranchName()
Signature: unit -> string option
|
Get the display name of the branch as shown in TeamCity See the documentation for more information |
getTeamCityRecentlyFailedTests()
Signature: unit -> seq<string> option
|
Name of recently failing tests See the documentation for more information |
IgnoreTestCase name message
Signature: name:string -> message:string -> unit
|
Ignores the test case. |
IgnoreTestCaseWithDetails(...)
Signature: name:string -> message:string -> details:string -> unit
|
Ignores the test case. |
PublishArticfact(path)
Signature: path:string -> unit
Attributes: [<Obsolete("There was a typo - please use PublishArtifact")>] |
OBSOLETEThere was a typo - please use PublishArtifact |
PublishArtifact(path)
Signature: path:string -> unit
|
Publishes an artifact on the TeamcCity build server. |
ReportBuildStatus status message
Signature: status:string -> message:string -> unit
|
Reports the build status. |
ReportProgress(message)
Signature: message:string -> unit
|
Reports the progress. |
ReportProgressFinish(message)
Signature: message:string -> unit
|
Reports the progress end. |
ReportProgressStart(message)
Signature: message:string -> unit
|
Reports the progress start. |
scrub
Signature: string -> string
|
|
sendCloseBlock
Signature: string -> unit
|
Close Named Block |
sendOpenBlock
Signature: string -> unit
|
Open Named Block |
sendStrToTeamCity(s)
Signature: s:string -> unit
|
Send message to TeamCity |
sendTeamCityCheckstyleImport(path)
Signature: path:string -> unit
|
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")>] |
OBSOLETEThis 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
|
Sends an dotcover, partcover, ncover or ncover3 results filename to TeamCity |
sendTeamCityDotNetDupFinderImport(path)
Signature: path:string -> unit
|
Sends an ReSharper dupfinder.exe results filename to TeamCity |
sendTeamCityError(error)
Signature: error:string -> unit
|
Sends an error to TeamCity |
sendTeamCityFindBugsImport(path)
Signature: path:string -> unit
|
Sends an FindBugs results filename to TeamCity |
sendTeamCityFxCopImport(path)
Signature: path:string -> unit
|
Sends an FxCop inspection results filename to TeamCity |
sendTeamCityFXCopImport(path)
Signature: path:string -> unit
|
Sends an FXCop results filename to TeamCity |
sendTeamCityGTestImport(path)
Signature: path:string -> unit
|
Sends an Google Test results filename to TeamCity |
sendTeamCityJSLintImport(path)
Signature: path:string -> unit
|
Sends an JSLint results filename to TeamCity |
sendTeamCityJUnitImport(path)
Signature: path:string -> unit
|
Sends an JUnit Ant task results filename to TeamCity |
sendTeamCityMSTestImport(path)
Signature: path:string -> unit
|
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
|
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
|
Sends an PMD Copy/Paste Detector results filename to TeamCity |
sendTeamCityPmdImport(path)
Signature: path:string -> unit
|
Sends an PMD inspections results filename to TeamCity |
sendTeamCityReSharperInspectCodeImport(...)
Signature: path:string -> unit
|
Sends an ReSharper inspectCode.exe results filename to TeamCity |
sendTeamCitySurefireImport(path)
Signature: path:string -> unit
|
Sends an Maven Surefire results filename to TeamCity |
sendToTeamCity format message
Signature: format:StringFormat<(string -> string)> -> message:string -> unit
|
Send message to TeamCity |
SetBuildNumber(buildNumber)
Signature: buildNumber:string -> unit
|
Sets the TeamCity build number. |
SetBuildStatistic key value
Signature: key:string -> value:string -> unit
|
Reports a build statistic. |
SetTeamCityParameter name value
Signature: name:string -> value:string -> unit
|
Reports a parameter value |
StartTestCase(testCaseName)
Signature: testCaseName:string -> unit
|
Starts the test case. |
StartTestSuite(testSuiteName)
Signature: testSuiteName:string -> unit
|
Starts the test suite. |
teamCityBlock(name)
Signature: name:string -> IDisposable
|
Open Named Block that will be closed when the block is disposed
Usage: |
TeamCityBuildConfigurationName
Signature: string option
|
The Name of the Build Configuration the current build belongs to or None if it's not on TeamCity. |
TeamCityBuildIsPersonal
Signature: bool
|
Is set to true if the build is a personal one. |
TeamCityBuildNumber
Signature: string option
|
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
|
The Name of the project the current build belongs to or None if it's not on TeamCity. |
TeamCityVersion
Signature: string option
|
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
|
Reports a failed test. |