Skip to main content

CI Pull Request Comments

The ci.comments section configures automatic GitHub pull-request comments with Terraform plan summaries, similar to tools like tfcmt and Atlantis. Comments are opt-in and are posted only when atmos terraform plan runs in a pull-request context with a rendered summary available.

Experimental

Configuration​

atmos.yaml
ci:
  comments:
    enabled: true
    behavior: upsert
ci.comments.enabled

Post or update GitHub pull-request comments with Terraform plan summaries. Atmos skips comments outside a pull-request context or when it cannot render a summary to post.

Requires: GitHub Actions pull-requests: write permission

Default: false (explicit opt-in)

Environment variable: ATMOS_CI_COMMENTS_ENABLED — overrides this setting when set.

ci.comments.behavior

How to handle comments:

  • create — Always create a new comment
  • update — Update existing comment or fail if none exists
  • upsert — Update existing comment or create new one (recommended)

Comments are identified by an HTML marker for the command, component, and stack combination, so each target gets its own comment that can be updated on subsequent plan runs.

Default: upsert

Environment Variables​

VariableDescription
ATMOS_CI_COMMENTS_ENABLEDOverride ci.comments.enabled (true/false). Takes precedence over the YAML configuration when set.

GitHub Actions Permissions​

PR comments require the pull-requests: write permission:

permissions:
  pull-requests: write

Custom Templates​

Comments reuse the rendered Terraform plan-summary template. Override that template with your own Markdown through Templates.

Related​