Skip to main content

CI PR Comments

The ci.comments section configures automatic comments on pull requests (GitHub) or merge requests (GitLab) with plan summaries, similar to tools like tfcmt and atlantis.

Experimental

Configuration​

atmos.yaml

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

Post or update comments on PRs (GitHub) or MRs (GitLab) with plan summaries.

Requires: pull-requests: write permission (GitHub) or API token with MR notes scope (GitLab)

Default: true

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 component/stack combination, so each component gets its own comment that is updated on subsequent runs.

Default: upsert

GitHub Actions Permissions​

PR comments require the pull-requests: write permission:

permissions:
  pull-requests: write

Custom Templates​

Override the default comment templates with your own Markdown. See Templates for configuration and template variables.