Atmos Pro Logo

Atmos Pro

ProductPricingDocsBlogChangelog
⌘K
Create Workspace
Atmos Pro Logo

Atmos Pro

ProductPricingDocsBlogChangelog
What is Atmos Pro?
Installation
How it Works
Workspaces
Team Members
Authentication
Ordered Deployments
Deployment Approvals
Deployment Locking
Drift Detection
Event Triggers
Workflow Dispatches
Repository Permissions
Audit Log
MCP Server
AI Credits
Troubleshooting
Workspaces
Atmos Stacks
Atmos CI
Atmos Toolchain
Cloud Authentication
GitHub Repository
GitHub Workflows
Commit From CI
Upload Instances
GitHub Environments
Deployment Locking
Drift Detection
CODEOWNERS Validation
Audit Log Webhooks
MCP Server
AWS
Private Cross-Repo Modules
Reference
Atmos Docs
Example Repository

Workflow Dispatches

Atmos Pro dispatches GitHub Actions workflows and waits for them to complete before proceeding with dependent workflows.


A workflow dispatch is a GitHub Actions feature that lets you manually trigger a workflow run. You can start these workflows from the GitHub web interface or programmatically via the GitHub API. This is especially useful for workflows that need to run on demand, rather than automatically in response to repository events.

With Workflow Dispatches, you can:

Run deployments manually for fixes or testing

Control deployment processes with flexibility

Benefit from the repeatability of GitHub Actions

Pass dynamic inputs to your workflows

Native GitHub Actions let you trigger workflows based on events like pull requests and merges. But unlike with GitHub Actions, Atmos Pro can determine exactly what changed—and dispatch workflows in the correct order, waiting for dependencies to finish before moving on.
Atmos Pro uses workflow_dispatch to trigger these workflows via GitHub’s API and then waits for the results.
Atmos Pro doesn’t run your workflows. It just tells GitHub what to run, and when.
The workflows run entirely within your GitHub environment—on hosted or self-hosted runners—using your existing environments, controls, and security settings.
Workflow dispatches in Atmos Pro work by mapping GitHub events to specific workflows that should be executed. When a GitHub event occurs (such as a pull request being opened or merged), Atmos Pro automatically dispatches the appropriate workflows based on your configuration.
The configuration for workflow dispatches is defined in your Atmos stack configuration files, where you specify which GitHub events should trigger which workflows and what inputs should be passed to those workflows.
Atmos Pro supports mapping different GitHub events to workflows. The currently supported events are:
  • Pull Request Events: Triggered by pull request activities like opening, synchronizing, reopening, or merging
  • Release Events: Triggered by release activities like publishing or editing releases
For each event type, you can specify which workflows should be dispatched and what inputs should be passed to them. For example, when a pull request is opened, you might want to run a Terraform plan workflow, and when it's merged, you might want to run a Terraform apply workflow.
Workflow dispatches can pass dynamic inputs to your GitHub Actions workflows. These inputs are typically extracted from your Atmos stack configuration using Atmos template functions.

Common Inputs

component

The Atmos component being deployed

stack

The Atmos stack being deployed

github_environment

The GitHub environment for the deployment
This allows your workflows to be context-aware and automatically adapt to the specific stack and component being processed.
One of the key features of Atmos Pro is its ability to dispatch workflows in the correct order based on component dependencies. When multiple components are affected by a change, Atmos Pro analyzes the dependency graph defined in your Atmos configuration and dispatches workflows in the proper sequence.
For example, if you have a database component that depends on a VPC component, Atmos Pro will ensure the VPC workflow completes before dispatching the database workflow. This dependency management is handled automatically based on the settings.depends_on configuration in your Atmos stack files.
How it works
Atmos Pro can hold or pause workflow dispatches before GitHub Actions minutes are spent. These circuit breakers still render the normal pull request status comment, but the affected workflows are not dispatched until an authorized user releases the gate.
  • Count-based hold: If one pull request event would dispatch more stacks than the repository threshold, Atmos Pro marks the batch as held and adds a Dispatch all N stacks anyway checkbox to the PR comment.
  • Rapid-push cooldown: If pushes arrive faster than the configured push-count/window threshold, Atmos Pro pauses dispatches for the PR and adds a Resume dispatches checkbox to the PR comment.
  • Draft PR hold: Draft pull requests render their affected stacks and a dispatch-anyway checkbox, but automatic dispatch waits until the PR is ready for review.
  • GitHub rate-limit hold: If a dispatch batch would consume too much of the installation's remaining GitHub REST API budget, Atmos Pro holds the batch and reserves headroom for checks, comments, reconciliation, and approvals.
Held and paused dispatches report the Atmos Pro check as action_required, not neutral or failure. This keeps required checks blocked while making it clear that the system is waiting for a human decision rather than still running or failing.
When a user resumes a rapid-push cooldown, Atmos Pro resets the cooldown baseline at that resume time. Earlier pushes no longer count toward the next cooldown window; the breaker can trip again only after enough new pushes arrive after the unfreeze.
When Atmos Pro dispatches a workflow, it needs to know what command the workflow represents — is it a plan, apply, detect, or remediate? This determines the badge shown in the deployments view and enables filtering by command type.
Command detection follows a two-step process:
  1. 1
    At dispatch time: Atmos Pro inspects the workflow filename for keywords like plan, apply, detect, drift, or remediate. For example, atmos-terraform-plan.yaml is recognized as a plan command, and atmos-terraform-apply.yaml as apply.
  2. 2
    At runtime: When the Atmos CLI finishes executing, it reports the actual command back to Atmos Pro. This CLI-reported command is canonical and overwrites any filename-based guess.
This means that even if a workflow has an ambiguous filename (like deploy.yaml), the command will be correctly identified once the workflow completes and Atmos reports back.
Naming Conventions
The workflow dispatch configuration is defined in your Atmos stack configuration files, typically in mixins that can be inherited across multiple stacks. This allows you to maintain consistent workflow dispatch behavior across your entire infrastructure while still allowing for stack-specific customizations when needed.
The configuration structure maps GitHub events to activity types, and then to specific workflows with their required inputs. This mapping is processed by Atmos Pro when GitHub events occur, ensuring that the right workflows are dispatched with the right parameters at the right time.
Configure Atmos
Now that you understand how workflow dispatches work, you can learn about configuring your Atmos stack files to define these mappings. The configuration process involves updating your Atmos configuration files to specify which events should trigger which workflows.
This feature is particularly useful for scenarios where you need to run deployments manually, such as for an emergency fix, a one-off task, or for testing changes in a development environment before promoting them to production.
By leveraging workflow dispatches, you gain the flexibility to control your deployment processes while still benefiting from the automation and repeatability of GitHub Actions.

Ready to configure workflow dispatches?

Visit the Atmos configuration page to set up workflow dispatches in your stack files.

Configure AtmosNext: Learn about Permissions

Event TriggersRepository Permissions
Atmos Pro Logo

Atmos Pro

The fastest way to deploy your apps on AWS with Terraform and GitHub Actions.

GitHubTwitterLinkedInYouTubeSlack

For Developers

  • Quick Start
  • Example Workflows
  • Atmos Documentation

Community

  • Register for Office Hours
  • Join the Slack Community
  • Try our Newsletter

Company

  • About Cloud Posse
  • Security
  • Pricing
  • Blog
  • Media Kit

Legal

  • SaaS Agreement
  • Terms of Use
  • Privacy Policy
  • Disclaimer
  • Cookie Policy

© 2026 Cloud Posse, LLC. All rights reserved.

Checking status...