GitHubActionsRunnerInfo Class

Summary

Provides GitHub Actions runner 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["GitHubActionsRunnerInfo"] class Type type-node

Syntax

public sealed class GitHubActionsRunnerInfo : GitHubActionsInfo

Constructors

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

Properties

Name Value Summary
Architecture GitHubActionsArchitecture
Gets the runner architecture of the runner executing the job.
ImageOS string
Gets the runner image OS on hosted agents.
ImageVersion string
Gets the runner image version on hosted agents.
Name string
Gets the name of the runner executing the job.
OS string
Gets the operating system of the runner executing the job.
Temp DirectoryPath
Gets the path of the temporary directory for the runner.
ToolCache DirectoryPath
Gets the path of the directory containing some of the pre-installed tools for GitHub-hosted runners.
User string
Gets the runner user name.
Workspace DirectoryPath
Gets the runner workspace directory path.

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