AzurePipelinesRepositoryInfo Class

Summary

Provides Azure Pipelines Repository information for the current build.
graph BT Type-->Base0["AzurePipelinesInfo"] click Base0 "/api/Cake.Common.Build.AzurePipelines/AzurePipelinesInfo" Base0-->Base1["object"] Type["AzurePipelinesRepositoryInfo"] class Type type-node

Syntax

public sealed class AzurePipelinesRepositoryInfo : AzurePipelinesInfo

Constructors

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

Properties

Name Value Summary
GitSubmoduleCheckout string
Gets the value you've selected for Checkout submodules on the repository tab.
Provider AzurePipelinesRepositoryType?
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.
SourceBranchName string
Gets name of 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 AzurePipelinesInfo
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
Inherited from AzurePipelinesInfo
GetEnvironmentString(string) string
Gets an environment variable as a string.
Inherited from AzurePipelinesInfo
GetEnvironmentUri(string) Uri
Gets an environment variable as a System.Uri.
Inherited from AzurePipelinesInfo
GetRepositoryType(string) AzurePipelinesRepositoryType?
Gets the current repository type as a AzurePipelinesRepositoryType from an environment variable.
Inherited from AzurePipelinesInfo

Extension Methods

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