Summary
Provides Azure Pipelines pull request information for the current build.
- Namespace
- Cake
.Common .Build .AzurePipelines .Data - Base Types
-
- object
- AzurePipelinesInfo
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 |
---|---|
Azure |
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 |
---|---|---|
Get |
bool |
Gets an environment variable as a
bool .
Inherited from AzurePipelinesInfo
|
Get |
int |
Gets an environment variable as a
int .
Inherited from AzurePipelinesInfo
|
GetEnvironmentString |
string |
Gets an environment variable as a
string .
Inherited from AzurePipelinesInfo
|
GetEnvironmentUri |
Uri |
Gets an environment variable as a
System.Uri .
Inherited from AzurePipelinesInfo
|
GetRepositoryType |
Azure |
Gets the current repository type as a
AzurePipelinesRepositoryType from an environment variable.
Inherited from AzurePipelinesInfo
|
Extension Methods
Name | Value | Summary |
---|---|---|
Dump |
string |
Get a basic string representation of specified object.
From LoggingExtensions
Requires the Cake.Incubator addin
|
IsIn |
bool |
Checks if the source is contained in a list
From EnumerableExtensions
Requires the Cake.Incubator addin
|
NotNull |
void |
From IssuesArgumentChecks
Requires the Cake.Issues addin
|
NotNull |
void |
Throws an exception if the specified parameter's value is null.
From Extensions
Requires the Cake.Ftp addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ThrowIfNull |
T |
Throws a
System.ArgumentNullException if the value is null, otherwise returns the value
From AssertExtensions
Requires the Cake.Incubator addin
|
ToDictionary |
IDictionary |
From ObjectHelpers
Requires the Cake.DeployParams addin
|
To |
string |
From StringExtensions
Requires the Cake.Issues addin
|