Triggers

Triggers define when a workflow starts. Atom provides a fluent API via the WorkflowTriggers helper class.

Built-in Trigger Shortcuts

Shortcut	Trigger Type	Description
`WorkflowTriggers.Manual`	`ManualTrigger`	Manual dispatch (workflow_dispatch)
`WorkflowTriggers.PushToMain`	`GitPushTrigger`	Push to `main` branch
`WorkflowTriggers.PullIntoMain`	`GitPullRequestTrigger`	Pull request targeting `main`

Git Push Trigger

// Push to specific branches
WorkflowTriggers.PushTo("main", "release/**")

// Full control
WorkflowTriggers.Push(
    includedBranches: ["main"],
    excludedBranches: [],
    includedPaths: ["src/**"],
    excludedPaths: ["docs/**"],
    includedTags: ["v*"],
    excludedTags: [])

`GitPushTrigger` Properties

Property	Description
`IncludedBranches`	Branches that trigger the workflow
`ExcludedBranches`	Branches to exclude
`IncludedPaths`	File paths that trigger the workflow
`ExcludedPaths`	File paths to exclude
`IncludedTags`	Tag patterns that trigger the workflow
`ExcludedTags`	Tag patterns to exclude

Git Pull Request Trigger

// PR targeting specific branches
WorkflowTriggers.PullInto("main", "release/**")

// Full control
WorkflowTriggers.PullRequest(
    includedBranches: ["main"],
    excludedBranches: [],
    includedPaths: ["src/**"],
    excludedPaths: [],
    types: ["opened", "synchronize"])

Manual Trigger

// Simple manual dispatch
WorkflowTriggers.Manual

// With inputs
WorkflowTriggers.ManualWithInputs(
    new ManualStringInput("version", "Version to deploy"),
    new ManualBoolInput("dry-run", "Dry run mode"),
    new ManualChoiceInput("environment", "Target environment", ["staging", "production"]))

Manual Input Types

Type	Description
`ManualStringInput`	Free-text string input
`ManualBoolInput`	Boolean toggle
`ManualChoiceInput`	Dropdown with predefined values

Platform-Specific Triggers

Platform modules can provide additional trigger types. For example, DecSm.Atom.Module.GithubWorkflows adds GithubTrigger for events like release:

new GithubTrigger(new On.Release([On.Release.ReleaseType.released]))

Combining Triggers

A workflow can have multiple triggers:

Triggers =
[
    WorkflowTriggers.Manual,
    WorkflowTriggers.PushToMain,
    WorkflowTriggers.PullIntoMain,
],

Next Steps

→ Workflow Options

Table of Contents