Class GitHubActions

Namespace

DotNetDo

Assembly

DotNetDo.Core.dll

Exposes GitHub Actions workflow commands and runner metadata.

public sealed class GitHubActions

Properties

Action

The Action metadata read from the provider environment.

public GitHubActionMetadata Action { get; }

Property Value

GitHubActionMetadata

Event

The Event metadata read from the provider environment.

public GitHubEventMetadata Event { get; }

Property Value

GitHubEventMetadata

Files

The Files metadata read from the provider environment.

public GitHubCommandFileMetadata Files { get; }

Property Value

GitHubCommandFileMetadata

Repository

The Repository metadata read from the provider environment.

public GitHubRepositoryMetadata Repository { get; }

Property Value

GitHubRepositoryMetadata

Run

The Run metadata read from the provider environment.

public GitHubRunMetadata Run { get; }

Property Value

GitHubRunMetadata

Runner

The Runner metadata read from the provider environment.

public GitHubRunnerMetadata Runner { get; }

Property Value

GitHubRunnerMetadata

Workflow

The Workflow metadata read from the provider environment.

public GitHubWorkflowMetadata Workflow { get; }

Property Value

GitHubWorkflowMetadata

Methods

AddMask(string)

Emits the provider's AddMask command immediately.

public void AddMask(string value)

Parameters

value string

AddPath(AbsolutePath)

Emits the provider's AddPath command immediately.

public void AddPath(AbsolutePath path)

Parameters

path AbsolutePath

AppendSummary(string)

Emits the provider's AppendSummary command immediately.

public void AppendSummary(string markdown)

Parameters

markdown string

ClearSummary()

Emits the provider's ClearSummary command immediately.

public void ClearSummary()

Debug(string)

Emits the provider's Debug command immediately.

public void Debug(string message)

Parameters

message string

Echo(bool)

Emits the provider's Echo command immediately.

public void Echo(bool enabled)

Parameters

enabled bool

EndGroup()

Emits the provider's EndGroup command immediately.

public void EndGroup()

Error(string, GitHubAnnotation?)

Emits the provider's Error command immediately.

public void Error(string message, GitHubAnnotation? annotation = null)

Parameters

message string

annotation GitHubAnnotation?

Notice(string, GitHubAnnotation?)

Emits the provider's Notice command immediately.

public void Notice(string message, GitHubAnnotation? annotation = null)

Parameters

message string

annotation GitHubAnnotation?

OverwriteSummary(string)

Emits the provider's OverwriteSummary command immediately.

public void OverwriteSummary(string markdown)

Parameters

markdown string

SaveState(string, string)

Emits the provider's SaveState command immediately.

public void SaveState(string name, string value)

Parameters

name string

value string

SetEnvironmentVariable(string, string)

Emits the provider's SetEnvironmentVariable command immediately.

public void SetEnvironmentVariable(string name, string value)

Parameters

name string

value string

SetOutput(string, string)

Emits the provider's SetOutput command immediately.

public void SetOutput(string name, string value)

Parameters

name string

value string

StartCommands(string)

Emits the provider's StartCommands command immediately.

public void StartCommands(string token)

Parameters

token string

StartGroup(string)

Emits the provider's StartGroup command immediately.

public void StartGroup(string title)

Parameters

title string

StopCommands(string)

Emits the provider's StopCommands command immediately.

public void StopCommands(string token)

Parameters

token string

Warning(string, GitHubAnnotation?)

Emits the provider's Warning command immediately.

public void Warning(string message, GitHubAnnotation? annotation = null)

Parameters

message string

annotation GitHubAnnotation?