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.

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

Comments without a pull request

The ci.comment function in a script takes a target of auto, pr, or commit. With the default auto, a run that has a pull request comments on it, and any other run (a push, for example) comments on the commit. Commit comments need the contents: write permission instead of pull-requests: write. Both kinds are gated by ci.comments.enabled.

Container image comments

The atmos container build and atmos container push commands post one image summary comment per registry/repository, so pushing a new tag updates the existing comment instead of adding another. The comment is attempted only when ci.comments.enabled is on; with comments off, nothing is previewed in the log. A comment body longer than 65,000 characters is truncated with a note, and a failed post is logged as a warning without failing the build. See container components.

Fork pull requests

Comments are held for a pull request from a fork under the elevated pull_request_target and workflow_run events. Native Terraform plan comments go through the same gate as comments from scripts. See the fork posting gate.

Environment Variables

Variable	Description
ATMOS_CI_COMMENTS_ENABLED	Override 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

• CI Configuration - Full configuration reference
• Templates - Custom template configuration
• Native CI Overview - Feature overview