ITeamCityProvider Interface

Summary

Represents a TeamCity provider.
Namespace
Cake.Common.Build.TeamCity
Implementing Types
graph BT Type["ITeamCityProvider"] class Type type-node Implementing0["TeamCityProvider"]-.->Type click Implementing0 "/api/Cake.Common.Build.TeamCity/TeamCityProvider"

Syntax

public interface ITeamCityProvider

Properties

Name Value Summary
Environment TeamCityEnvironmentInfo
Gets the TeamCity environment.
IsRunningOnTeamCity bool
Gets a value indicating whether the current build is running on TeamCity.

Methods

Name Value Summary
BuildProblem(string, string) void
Report a build problem to TeamCity.
ImportData(string, FilePath) void
Tell TeamCity to import data of a given type.
ImportDotCoverCoverage(FilePath, DirectoryPath) void
Tell TeamCity to import coverage from dotCover snapshot file.
PublishArtifacts(string) void
Tells TeamCity to publish artifacts in the given directory.
SetBuildNumber(string) void
Tells TeamCity to change the current build number.
SetParameter(string, string) void
Tells TeamCity to set a named parameter with a given value.
WriteAppendBuildStatus(string, string) void
Write a status message to the TeamCity build log. - append message to build status.
WriteEndBlock(string) void
Write the end of a message block to the TeamCity build log.
WriteEndBuildBlock(string) void
Write the end of a build block to the TeamCity build log.
WriteEndProgress(string) void
Write a progressFinish message to the TeamCity build log.
WritePrependBuildStatus(string, string) void
Write a status message to the TeamCity build log. - Prepend message to build status.
WriteProgressMessage(string) void
Write a progress message to the TeamCity build log.
WriteReplacementBuildStatus(string, string) void
Write a status message to the TeamCity build log. - replace existing build status.
WriteStartBlock(string) void
Write the start of a message block to the TeamCity build log.
WriteStartBuildBlock(string) void
Write the start of a build block to the TeamCity build log.
WriteStartProgress(string) void
Write a progressStart message to the TeamCity build log.
WriteStatistic(string, string) void
Write a statistic message to the TeamCity build log.
WriteStatus(string, string, string) void
Write a message to the TeamCity build log. - Messages not added to the build status.

Extension Methods

Name Value Summary
Block(string) IDisposable
Writes the start of a TeamCity message block, then returns a disposable that writes the report block end on dispose.
BuildBlock(string) IDisposable
Writes the start of a TeamCity build block, then returns a disposable that writes the build block end on dispose.
Dump<ITeamCityProvider>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<ITeamCityProvider>(ITeamCityProvider[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<ITeamCityProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
NotNull<ITeamCityProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
ThrowIfNull<ITeamCityProvider>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<ITeamCityProvider>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin