Class GithubAction
- Namespace
- Invex.StructuredText.GithubActions.GithubActionModel
- Assembly
- Invex.StructuredText.GithubActions.dll
The root model of a GitHub Actions workflow file (.github/workflows/*.yml).
Serialize it with GithubActionWriter.
public sealed record GithubAction
- Inheritance
-
objectGithubAction
Constructors
GithubAction()
public GithubAction()
Properties
Concurrency
Concurrency settings that limit how many runs of this workflow execute at once.
public Concurrency? Concurrency { get; init; }
Property Value
Env
Environment variables available to all jobs and steps in the workflow.
public IReadOnlyDictionary<string, Template>? Env { get; init; }
Property Value
- IReadOnlyDictionary<string, Template>
Jobs
The jobs that make up the workflow. At least one job is required.
public required IReadOnlyList<Job> Jobs { get; init; }
Property Value
- IReadOnlyList<Job>
Name
The name of the workflow, shown in the GitHub Actions UI.
public string? Name { get; init; }
Property Value
- string
On
The events that trigger the workflow (on). At least one event is required.
public required IReadOnlyList<On> On { get; init; }
Property Value
- IReadOnlyList<On>
Permissions
The default GITHUB_TOKEN permissions for all jobs in the workflow.
Can be overridden per job.
public Permissions? Permissions { get; init; }
Property Value
RunName
The name for workflow runs generated from the workflow (run-name).
Can include expressions, e.g. referencing github.actor.
public Template? RunName { get; init; }