GitHubActionsProvider Class

Summary

Responsible for communicating with GitHub Actions.
Namespace
Cake.Common.Build.GitHubActions
Interfaces
Base Types
  • object
graph BT Type-->Base0["object"] Type-.->Interface0["IGitHubActionsProvider"] click Interface0 "/api/Cake.Common.Build.GitHubActions/IGitHubActionsProvider" Type["GitHubActionsProvider"] class Type type-node

Syntax

public class GitHubActionsProvider : IGitHubActionsProvider

Constructors

Name Summary
GitHubActionsProvider(ICakeEnvironment, IFileSystem, IBuildSystemServiceMessageWriter) Initializes a new instance of the GitHubActionsProvider class.

Properties

Name Value Summary
Commands GitHubActionsCommands
Gets the GitHub Actions commands.
Environment GitHubActionsEnvironmentInfo
Gets the GitHub Actions environment.
IsRunningOnGitHubActions bool
Gets a value indicating whether the current build is running on GitHub Actions.

Extension Methods

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