GitHubActionsEnvironmentInfo Class

Summary

Provides GitHub Actions environment information for a 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["GitHubActionsEnvironmentInfo"] class Type type-node

Syntax

public sealed class GitHubActionsEnvironmentInfo : GitHubActionsInfo

Constructors

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

Properties

Name Value Summary
Home DirectoryPath
Gets the GitHub Actions home directory.
PullRequest GitHubActionsPullRequestInfo
Gets GitHub Actions pull request information.
Runner GitHubActionsRunnerInfo
Gets GitHub Actions runner information.
Runtime GitHubActionsRuntimeInfo
Gets GitHub Actions runtime information.
Workflow GitHubActionsWorkflowInfo
Gets the GitHub Actions workflow information.

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