GitHubActionsInfo Class

Summary

Base class used to provide information about the GitHub Actions environment.
Namespace
Cake.Common.Build.GitHubActions
Base Types
  • object
Derived Types
graph BT Type-->Base0["object"] Type["GitHubActionsInfo"] class Type type-node Derived0["GitHubActionsRuntimeInfo"]-->Type click Derived0 "/api/Cake.Common.Build.GitHubActions.Data/GitHubActionsRuntimeInfo" Derived1["GitHubActionsPullRequestInfo"]-->Type click Derived1 "/api/Cake.Common.Build.GitHubActions.Data/GitHubActionsPullRequestInfo" Derived2["GitHubActionsEnvironmentInfo"]-->Type click Derived2 "/api/Cake.Common.Build.GitHubActions.Data/GitHubActionsEnvironmentInfo" Derived3["GitHubActionsRunnerInfo"]-->Type click Derived3 "/api/Cake.Common.Build.GitHubActions.Data/GitHubActionsRunnerInfo" Derived4["GitHubActionsWorkflowInfo"]-->Type click Derived4 "/api/Cake.Common.Build.GitHubActions.Data/GitHubActionsWorkflowInfo"

Syntax

public abstract class GitHubActionsInfo

Constructors

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

Methods

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

Extension Methods

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