AzurePipelinesPullRequestInfo Class

Summary

Provides Azure Pipelines pull request information for the current build.
Namespace
Cake.Common.Build.AzurePipelines.Data
Base Types
graph BT Type-->Base0["AzurePipelinesInfo"] click Base0 "/api/Cake.Common.Build.AzurePipelines/AzurePipelinesInfo" Base0-->Base1["object"] Type["AzurePipelinesPullRequestInfo"] class Type type-node

Syntax

public sealed class AzurePipelinesPullRequestInfo : AzurePipelinesInfo

Constructors

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

Properties

Name Value Summary
Id int
Gets the ID of the pull request that caused this build. This value is set only if the build ran because of a Git PR affected by a branch policy.
IsFork bool
Gets a value indicating whether the pull request is from a fork of the repository.
IsPullRequest bool
Gets a value indicating whether the current build was started by a pull request.
Number int
Gets the number of the pull request that caused this build. This value is set for pull requests from GitHub which have a different pull request ID and pull request number.
SourceBranch string
Gets the branch that is being reviewed in a pull request.
SourceRepositoryUri Uri
Gets the URL to the repo that contains the pull requests.
TargetBranch string
Gets the branch that is the target of a pull request.

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