GitLabCIPullRequestInfo Class

Summary

Provides GitLab CI pull request information for the current build.
Namespace
Cake.Common.Build.GitLabCI.Data
Base Types
graph BT Type-->Base0["GitLabCIInfo"] click Base0 "/api/Cake.Common.Build.GitLabCI/GitLabCIInfo" Base0-->Base1["object"] Type["GitLabCIPullRequestInfo"] class Type type-node

Syntax

public sealed class GitLabCIPullRequestInfo : GitLabCIInfo

Constructors

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

Properties

Name Value Summary
Id int
Gets the pull request id that GitLab CI uses internally.
IId int
Gets the pull request id scoped to the project.
IsPullRequest bool
Gets a value indicating whether the current build was started by a pull request.

Methods

Name Value Summary
GetEnvironmentBoolean(string, string) bool
Gets an environment variable as a bool.
Inherited from GitLabCIInfo
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
Inherited from GitLabCIInfo
GetEnvironmentInteger(string, string) int
Gets an environment variable as a int.
Inherited from GitLabCIInfo
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
Inherited from GitLabCIInfo
GetEnvironmentString(string, string) string
Gets an environment variable as a string.
Inherited from GitLabCIInfo
GetEnvironmentString(string) string
Gets an environment variable as a string.
Inherited from GitLabCIInfo

Extension Methods

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