GitHubActionsRuntimeInfo Class

Summary

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

Syntax

public sealed class GitHubActionsRuntimeInfo : GitHubActionsInfo

Constructors

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

Properties

Name Value Summary
EnvPath FilePath
Gets the path to environment file to set an environment variable that the following steps in a job can use.
IsRuntimeAvailable bool
Gets a value indicating whether the GitHub Actions Runtime is available for the current build.
OutputPath FilePath
Gets the path to output file to set an output parameter that the following steps in a job can use.
ResultsUrl string
Gets the current runtime API endpoint url for the job.
StepSummary FilePath
Gets the path to output file to set the step summary.
SystemPath FilePath
Gets the path to path file to add a path to system path that the following steps in a job can use.
Token string
Gets the current runtime API authorization token.
Url string
Gets the current runtime API endpoint url.

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