TFBuildRepositoryInfo Class

Summary

Provides TF Build Repository information for the current build
Namespace
Cake.Common.Build.TFBuild.Data
Base Types
graph BT Type-->Base0["TFInfo"] click Base0 "/api/Cake.Common.Build.TFBuild/TFInfo" Base0-->Base1["object"] Type["TFBuildRepositoryInfo"] class Type type-node

Syntax

public sealed class TFBuildRepositoryInfo : TFInfo

Constructors

Name Summary
TFBuildRepositoryInfo(ICakeEnvironment) Initializes a new instance of the TFBuildRepositoryInfo class.

Properties

Name Value Summary
Branch string
Gets name of the branch the build was queued for.
GitSubmoduleCheckout string
Gets the value you've selected for Checkout submodules on the repository tab
Provider TFRepositoryType?
Gets the type of the current repository.
RepoName string
Gets the name of the repository
Shelveset string
Gets the name of the shelveset you are building, if you are running a gated build or a shelveset build.
SourceBranch string
Gets the branch the build was queued for
SourceVersion string
Gets the latest version control change that is included in this build.
SourceVersionMessage string
Gets the comment of the commit or changeset.

Methods

Name Value Summary
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
Inherited from TFInfo
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
Inherited from TFInfo
GetEnvironmentString(string) string
Gets an environment variable as a string.
Inherited from TFInfo
GetEnvironmentUri(string) Uri
Gets an environment variable as a System.Uri.
Inherited from TFInfo
GetRepositoryType(string) TFRepositoryType?
Gets the current repository type as a TFRepositoryType from an environment variable.
Inherited from TFInfo

Extension Methods

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