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
-
objectWorkflowTriggers
Properties
Manual
Gets a trigger that allows the workflow to be started manually, without inputs.
public static ManualTrigger Manual { get; }
Property Value
PullIntoMain
Gets a trigger that starts the workflow for pull requests targeting the main branch.
public static GitPullRequestTrigger PullIntoMain { get; }
Property Value
PushToMain
Gets a trigger that starts the workflow for pushes to the main branch.
public static GitPushTrigger PushToMain { get; }
Property Value
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
inputsManualInput[]The inputs that can be supplied when starting the workflow.
Returns
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
includedBranchesstring[]The target branches that activate the trigger.
Returns
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
includedBranchesIReadOnlyList<string>The target branches that activate the trigger.
excludedBranchesIReadOnlyList<string>The target branches that are excluded from the trigger.
includedPathsIReadOnlyList<string>The changed file paths that activate the trigger.
excludedPathsIReadOnlyList<string>The changed file paths that are excluded from the trigger.
typesIReadOnlyList<string>The pull request event types that activate the trigger (e.g., "opened").
Returns
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
includedBranchesIReadOnlyList<string>The branches that activate the trigger.
excludedBranchesIReadOnlyList<string>The branches that are excluded from the trigger.
includedPathsIReadOnlyList<string>The changed file paths that activate the trigger.
excludedPathsIReadOnlyList<string>The changed file paths that are excluded from the trigger.
includedTagsIReadOnlyList<string>The tags that activate the trigger.
excludedTagsIReadOnlyList<string>The tags that are excluded from the trigger.
Returns
PushTo(params string[])
Creates a trigger that starts the workflow for pushes to the specified branches.
public static GitPushTrigger PushTo(params string[] includedBranches)
Parameters
includedBranchesstring[]The branches that activate the trigger.