TFBuildProvider Class

Summary

Responsible for communicating with Team Foundation Build (VSTS or TFS).
Namespace
Cake.Common.Build.TFBuild
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["ITFBuildProvider"] click Interface0 "/api/Cake.Common.Build.TFBuild/ITFBuildProvider" Type["TFBuildProvider"] class Type type-node

Syntax

public sealed class TFBuildProvider : ITFBuildProvider

Constructors

Name Summary
TFBuildProvider(ICakeEnvironment, ICakeLog) Initializes a new instance of the TFBuildProvider class.

Properties

Name Value Summary
Commands ITFBuildCommands
Gets the TF Build Commands provider.
Environment TFBuildEnvironmentInfo
Gets the TF Build environment.
IsRunningOnAzurePipelines bool
Gets a value indicating whether the current build is running on Azure Pipelines.
IsRunningOnAzurePipelinesHosted bool
Gets a value indicating whether the current build is running on hosted Azure Pipelines.
IsRunningOnTFS bool
Gets a value indicating whether the current build is running on TFS.
IsRunningOnVSTS bool
Gets a value indicating whether the current build is running on VSTS.

Extension Methods

Name Value Summary
Dump<TFBuildProvider>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<TFBuildProvider>(TFBuildProvider[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<TFBuildProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<TFBuildProvider>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<TFBuildProvider>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<TFBuildProvider>(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