GitHubActionsPullRequestInfo Class

Summary

Provides GitHub Actions pull request information for the current build.
Namespace
Cake.Common.Build.GitHubActions.Data
Base Types
graph BT Type-->Base0["GitHubActionsInfo"] click Base0 "/api/Cake.Common.Build.GitHubActions/GitHubActionsInfo" Base0-->Base1["object"] Type["GitHubActionsPullRequestInfo"] class Type type-node

Syntax

public sealed class GitHubActionsPullRequestInfo : GitHubActionsInfo

Constructors

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

Properties

Name Value Summary
IsPullRequest bool
Gets a value indicating whether the current build was started by a pull request.

Methods

Name Value Summary
GetEnvironmentBoolean(string) bool
Gets an environment variable as a bool.
Inherited from GitHubActionsInfo
GetEnvironmentDirectoryPath(string) DirectoryPath
Gets an environment variable as a DirectoryPath.
Inherited from GitHubActionsInfo
GetEnvironmentFilePath(string) FilePath
Gets an environment variable as a FilePath.
Inherited from GitHubActionsInfo
GetEnvironmentInteger(string) int
Gets an environment variable as a int.
Inherited from GitHubActionsInfo
GetEnvironmentString(string) string
Gets an environment variable as a string.
Inherited from GitHubActionsInfo

Extension Methods

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