GitHubActionsCommands Class

Summary

Provides GitHub Actions commands for a current build.
Namespace
Cake.Common.Build.GitHubActions.Commands
Base Types
  • object
graph BT Type-->Base0["object"] Type["GitHubActionsCommands"] class Type type-node

Syntax

public sealed class GitHubActionsCommands

Constructors

Methods

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.
DownloadArtifact(string, DirectoryPath) Task
Download remote artifact container into local directory.
SetEnvironmentVariable(string, string) void
Creates or updates an environment variable for any steps running next in a job.
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.

Extension Methods

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