CI Configuration

The ci section of atmos.yaml configures native CI/CD integration, including output variables, job summaries, status checks, PR comments, and template overrides.

Experimental

Quick Start

atmos.yaml

ci:
  enabled: true
  output:
    enabled: true
    variables:
      - has_changes
      - has_additions
      - has_destructions
      - plan_summary
  summary:
    enabled: true
  checks:
    enabled: false
  comments:
    enabled: true
    behavior: upsert

Configuration Reference

ci.enabled

Explicitly enable or disable CI mode. When not set, CI mode is auto-detected from environment variables (CI=true or GITHUB_ACTIONS=true).

Default: Auto-detected

Sections

📄️ cache

Configure the CI build cache that restores and saves the toolchain and other regenerable artifacts across CI jobs.

📄️ checks

Configure commit status checks for CI pipelines

📄️ comments

Configure PR/MR comments with plan summaries

📄️ output

Configure CI output variables for downstream jobs

📄️ summary

Configure rich job summaries for CI pipelines

📄️ templates

Customize CI job summary and PR comment templates

Full Example

atmos.yaml

ci:
  # Auto-enabled when CI detected, or set explicitly
  enabled: true

  # Output variables for downstream jobs
  output:
    enabled: true
    variables:
      - has_changes
      - has_additions
      - has_destructions
      - artifact_key
      - plan_summary

  # Job summary with plan/apply results
  summary:
    enabled: true

  # Commit status checks
  checks:
    enabled: true
    context_prefix: "atmos"

  # PR/MR comments
  comments:
    enabled: true
    behavior: upsert

  # Template overrides
  templates:
    base_path: ".atmos/ci/templates"
    terraform:
      plan: "plan.md"
      apply: "apply.md"

CI Detection

CI mode is auto-enabled when any of these environment variables are set:

• CI=true (set by most CI providers)
• GITHUB_ACTIONS=true (set by GitHub Actions)

Override with the --ci flag or ci.enabled configuration.

Environment Variables

Variable	Description
ATMOS_CI	Explicitly enable CI mode (true/false)
ATMOS_CI_COMMENTS_ENABLED	Override ci.comments.enabled (true/false)
CI	Standard CI environment variable (set by most CI providers)
GITHUB_ACTIONS	Set by GitHub Actions runner
GITHUB_TOKEN / GH_TOKEN	GitHub API token (required for status checks and PR comments)
GITHUB_OUTPUT	File path for CI output variables (set by GitHub Actions)
GITHUB_STEP_SUMMARY	File path for job summaries (set by GitHub Actions)
GITHUB_REPOSITORY	Repository name in owner/repo format
GITHUB_SHA	Current commit SHA

Related

• Native CI Overview - Feature overview and quick start
• Native CI Overview - Feature overview
• Planfile Storage - Store and verify planfiles
• atmos terraform plan --ci - Plan with CI integration
• atmos terraform deploy --ci - Deploy with plan verification