Table of Contents

Class Step

Namespace
Invex.StructuredText.GithubActions.GithubActionModel
Assembly
Invex.StructuredText.GithubActions.dll

A single step within a job. This is a discriminated union: construct a Step.UsesStep to run an action or a Step.RunStep to run shell commands. The properties on this base record are shared by both variants.

[Union]
public abstract record Step
Inheritance
object
Step
Derived

Properties

ContinueOnError

Whether the job passes when this step fails (continue-on-error).

public Template? ContinueOnError { get; init; }

Property Value

Template

Env

Environment variables available to the step (env).

public IReadOnlyDictionary<string, Template>? Env { get; init; }

Property Value

IReadOnlyDictionary<string, Template>

Id

A unique identifier for the step (id), used to reference its outputs and outcome via StepOutput(string, string).

public string? Id { get; init; }

Property Value

string

If

A condition that must evaluate to true for the step to run (if). Written in expression context, so the expression is not wrapped in ${{ }}.

public BoolExpr? If { get; init; }

Property Value

BoolExpr

Name

The display name of the step (name).

public Template? Name { get; init; }

Property Value

Template

TimeoutMinutes

The maximum number of minutes the step may run before being terminated (timeout-minutes).

public Template? TimeoutMinutes { get; init; }

Property Value

Template

With

Input parameters for the step (with), keyed by input name. Values containing line breaks are written as multi-line block values.

public IReadOnlyDictionary<string, Template>? With { get; init; }

Property Value

IReadOnlyDictionary<string, Template>

WorkingDirectory

The working directory the step runs in (working-directory).

public Template? WorkingDirectory { get; init; }

Property Value

Template

Methods

Match(Action<UsesStep>, Action<RunStep>)

public abstract void Match(Action<Step.UsesStep> usesStep, Action<Step.RunStep> runStep)

Parameters

usesStep Action<Step.UsesStep>
runStep Action<Step.RunStep>

MatchRunStep(Action<RunStep>, Action)

public abstract void MatchRunStep(Action<Step.RunStep> runStep, Action @else)

Parameters

runStep Action<Step.RunStep>
else Action

MatchRunStep<TMatchOutput>(Func<RunStep, TMatchOutput>, Func<TMatchOutput>)

public abstract TMatchOutput MatchRunStep<TMatchOutput>(Func<Step.RunStep, TMatchOutput> runStep, Func<TMatchOutput> @else)

Parameters

runStep Func<Step.RunStep, TMatchOutput>
else Func<TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

MatchRunStep<TState>(TState, Action<TState, RunStep>, Action<TState>)

public abstract void MatchRunStep<TState>(TState state, Action<TState, Step.RunStep> runStep, Action<TState> @else)

Parameters

state TState
runStep Action<TState, Step.RunStep>
else Action<TState>

Type Parameters

TState

MatchRunStep<TState, TMatchOutput>(TState, Func<TState, RunStep, TMatchOutput>, Func<TState, TMatchOutput>)

public abstract TMatchOutput MatchRunStep<TState, TMatchOutput>(TState state, Func<TState, Step.RunStep, TMatchOutput> runStep, Func<TState, TMatchOutput> @else)

Parameters

state TState
runStep Func<TState, Step.RunStep, TMatchOutput>
else Func<TState, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

MatchUsesStep(Action<UsesStep>, Action)

public abstract void MatchUsesStep(Action<Step.UsesStep> usesStep, Action @else)

Parameters

usesStep Action<Step.UsesStep>
else Action

MatchUsesStep<TMatchOutput>(Func<UsesStep, TMatchOutput>, Func<TMatchOutput>)

public abstract TMatchOutput MatchUsesStep<TMatchOutput>(Func<Step.UsesStep, TMatchOutput> usesStep, Func<TMatchOutput> @else)

Parameters

usesStep Func<Step.UsesStep, TMatchOutput>
else Func<TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

MatchUsesStep<TState>(TState, Action<TState, UsesStep>, Action<TState>)

public abstract void MatchUsesStep<TState>(TState state, Action<TState, Step.UsesStep> usesStep, Action<TState> @else)

Parameters

state TState
usesStep Action<TState, Step.UsesStep>
else Action<TState>

Type Parameters

TState

MatchUsesStep<TState, TMatchOutput>(TState, Func<TState, UsesStep, TMatchOutput>, Func<TState, TMatchOutput>)

public abstract TMatchOutput MatchUsesStep<TState, TMatchOutput>(TState state, Func<TState, Step.UsesStep, TMatchOutput> usesStep, Func<TState, TMatchOutput> @else)

Parameters

state TState
usesStep Func<TState, Step.UsesStep, TMatchOutput>
else Func<TState, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

Match<TMatchOutput>(Func<UsesStep, TMatchOutput>, Func<RunStep, TMatchOutput>)

public abstract TMatchOutput Match<TMatchOutput>(Func<Step.UsesStep, TMatchOutput> usesStep, Func<Step.RunStep, TMatchOutput> runStep)

Parameters

usesStep Func<Step.UsesStep, TMatchOutput>
runStep Func<Step.RunStep, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TMatchOutput

Match<TState>(TState, Action<TState, UsesStep>, Action<TState, RunStep>)

public abstract void Match<TState>(TState state, Action<TState, Step.UsesStep> usesStep, Action<TState, Step.RunStep> runStep)

Parameters

state TState
usesStep Action<TState, Step.UsesStep>
runStep Action<TState, Step.RunStep>

Type Parameters

TState

Match<TState, TMatchOutput>(TState, Func<TState, UsesStep, TMatchOutput>, Func<TState, RunStep, TMatchOutput>)

public abstract TMatchOutput Match<TState, TMatchOutput>(TState state, Func<TState, Step.UsesStep, TMatchOutput> usesStep, Func<TState, Step.RunStep, TMatchOutput> runStep)

Parameters

state TState
usesStep Func<TState, Step.UsesStep, TMatchOutput>
runStep Func<TState, Step.RunStep, TMatchOutput>

Returns

TMatchOutput

Type Parameters

TState
TMatchOutput

UnwrapRunStep()

public abstract Step.RunStep UnwrapRunStep()

Returns

Step.RunStep

UnwrapUsesStep()

public abstract Step.UsesStep UnwrapUsesStep()

Returns

Step.UsesStep