Table of Contents

Class WorkflowTriggers

Namespace
Invex.Atom.Workflows.Definition.Triggers
Assembly
Invex.Atom.Workflows.dll

Provides factories and presets for common workflow triggers, and serves as an extension anchor for platform-specific trigger factories.

public static class WorkflowTriggers
Inheritance
object
WorkflowTriggers

Properties

Manual

Gets a trigger that allows the workflow to be started manually, without inputs.

public static ManualTrigger Manual { get; }

Property Value

ManualTrigger

PullIntoMain

Gets a trigger that starts the workflow for pull requests targeting the main branch.

public static GitPullRequestTrigger PullIntoMain { get; }

Property Value

GitPullRequestTrigger

PushToMain

Gets a trigger that starts the workflow for pushes to the main branch.

public static GitPushTrigger PushToMain { get; }

Property Value

GitPushTrigger

Methods

ManualWithInputs(params ManualInput[])

Creates a trigger that allows the workflow to be started manually with the specified inputs.

public static ManualTrigger ManualWithInputs(params ManualInput[] inputs)

Parameters

inputs ManualInput[]

The inputs that can be supplied when starting the workflow.

Returns

ManualTrigger

A ManualTrigger.

PullInto(params string[])

Creates a trigger that starts the workflow for pull requests targeting the specified branches.

public static GitPullRequestTrigger PullInto(params string[] includedBranches)

Parameters

includedBranches string[]

The target branches that activate the trigger.

Returns

GitPullRequestTrigger

A GitPullRequestTrigger.

PullRequest(IReadOnlyList<string>, IReadOnlyList<string>, IReadOnlyList<string>, IReadOnlyList<string>, IReadOnlyList<string>)

Creates a fully-configured pull request trigger.

public static GitPullRequestTrigger PullRequest(IReadOnlyList<string> includedBranches, IReadOnlyList<string> excludedBranches, IReadOnlyList<string> includedPaths, IReadOnlyList<string> excludedPaths, IReadOnlyList<string> types)

Parameters

includedBranches IReadOnlyList<string>

The target branches that activate the trigger.

excludedBranches IReadOnlyList<string>

The target branches that are excluded from the trigger.

includedPaths IReadOnlyList<string>

The changed file paths that activate the trigger.

excludedPaths IReadOnlyList<string>

The changed file paths that are excluded from the trigger.

types IReadOnlyList<string>

The pull request event types that activate the trigger (e.g., "opened").

Returns

GitPullRequestTrigger

A GitPullRequestTrigger.

Push(IReadOnlyList<string>, IReadOnlyList<string>, IReadOnlyList<string>, IReadOnlyList<string>, IReadOnlyList<string>, IReadOnlyList<string>)

Creates a fully-configured push trigger.

public static GitPushTrigger Push(IReadOnlyList<string> includedBranches, IReadOnlyList<string> excludedBranches, IReadOnlyList<string> includedPaths, IReadOnlyList<string> excludedPaths, IReadOnlyList<string> includedTags, IReadOnlyList<string> excludedTags)

Parameters

includedBranches IReadOnlyList<string>

The branches that activate the trigger.

excludedBranches IReadOnlyList<string>

The branches that are excluded from the trigger.

includedPaths IReadOnlyList<string>

The changed file paths that activate the trigger.

excludedPaths IReadOnlyList<string>

The changed file paths that are excluded from the trigger.

includedTags IReadOnlyList<string>

The tags that activate the trigger.

excludedTags IReadOnlyList<string>

The tags that are excluded from the trigger.

Returns

GitPushTrigger

A GitPushTrigger.

PushTo(params string[])

Creates a trigger that starts the workflow for pushes to the specified branches.

public static GitPushTrigger PushTo(params string[] includedBranches)

Parameters

includedBranches string[]

The branches that activate the trigger.

Returns

GitPushTrigger

A GitPushTrigger.