Summary

Provides GitHub Actions commands for a current build.

Namespace

Cake.Common.Build.GitHubActions.Commands

Base Types

graph BT Type-->Base0["object"] Type["GitHubActionsCommands"] class Type type-node

Syntax

public sealed class GitHubActionsCommands

Name	Summary
GitHubActionsCommands(ICakeEnvironment, IFileSystem, IBuildSystemServiceMessageWriter, GitHubActionsEnvironmentInfo, Func<string, HttpClient>)	Initializes a new instance of the `GitHubActionsCommands` class.

Name	Value	Summary
AddPath(DirectoryPath)	void	Prepends a directory to the system PATH variable and automatically makes it available to all subsequent actions in the current job.
Debug(string)	void	Write debug message to the build log.
DownloadArtifact(string, DirectoryPath)	Task	Download remote artifact container into local directory.
EndGroup()	void	End a group in the build log.
Error(string, GitHubActionsAnnotation)	void	Write error message to the build log.
Notice(string, GitHubActionsAnnotation)	void	Write notice message to the build log.
SetEnvironmentVariable(string, string)	void	Creates or updates an environment variable for any steps running next in a job.
SetOutputParameter(string, string)	void	Creates or updates an output parameter for any steps running next in a job.
SetSecret(string)	void	Registers a secret which will get masked in the build log.
SetStepSummary(string)	void	Creates or updates the step summary for a GitHub workflow.
StartGroup(string)	void	Start a group in the build log.
UploadArtifact(DirectoryPath, string)	Task	Upload local directory files into a file container folder, and create an artifact.
UploadArtifact(FilePath, string)	Task	Upload local file into a file container folder, and create an artifact.
Warning(string, GitHubActionsAnnotation)	void	Write warning message to the build log.

Name	Value	Summary
Dump<GitHubActionsCommands>()	string	Get a basic string representation of specified object. From LoggingExtensions Requires the Cake.Incubator addin
IsIn<GitHubActionsCommands>(GitHubActionsCommands[])	bool	Checks if the source is contained in a list From EnumerableExtensions Requires the Cake.Incubator addin
NotNull<GitHubActionsCommands>(string)	void	Throws an exception if the specified parameter's value is null. From Extensions Requires the Cake.Ftp addin
NotNull<GitHubActionsCommands>(string)	void	Throws an exception if the specified parameter's value is null. From IssuesArgumentChecks Requires the Cake.Issues addin
ThrowIfNull<GitHubActionsCommands>(string, string)	T	Throws a `System.ArgumentNullException` with a specific message if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ThrowIfNull<GitHubActionsCommands>(string)	T	Throws a `System.ArgumentNullException` if the value is null, otherwise returns the value From AssertExtensions Requires the Cake.Incubator addin
ToDictionary()	IDictionary<string, object>	From ObjectHelpers Requires the Cake.DeployParams addin