Skip to content

docs: refresh CI page with native CI workflows; deprecate legacy GH Actions#2373

Merged
aknysh merged 11 commits intomainfrom
osterman/ci-docs-refresh
Apr 29, 2026
Merged

docs: refresh CI page with native CI workflows; deprecate legacy GH Actions#2373
aknysh merged 11 commits intomainfrom
osterman/ci-docs-refresh

Conversation

@osterman
Copy link
Copy Markdown
Member

@osterman osterman commented Apr 28, 2026

what

  • Move six legacy Cloud Posse GitHub Action docs (affected-stacks, atmos-terraform-plan/apply, drift detection/remediation, and the index) from website/docs/integrations/github-actions/ to website/docs/deprecated/github-actions/, with :::warning Deprecated banners on each page pointing readers to /ci.
  • Rebuild website/docs/ci/ci.mdx around the two reference repos cloudposse-examples/atmos-native-ci and cloudposse-examples/atmos-native-ci-advanced — concrete excerpts for deploy-on-PR, deploy-on-merge, preview cleanup, and an atmos describe affected --format=matrix fan-out, plus a discreet pointer to the deprecated content.
  • Add client-redirects from all six legacy /integrations/github-actions/* URLs to /ci, add a collapsed "Deprecated" sub-category at the bottom of the Resources sidebar, keep setup-atmos and component-updater in the (now smaller) GitHub Actions sidebar entry, and repoint cross-links across docs, two blog posts, and the roadmap.

why

  • Atmos now ships native CI integration (job summaries, output variables, status checks, planfile storage) directly in the CLI, so atmos terraform plan/apply/deploy already produces the artifacts the wrapper actions used to provide — the legacy actions are no longer the recommended path for new projects.
  • The previous structure buried native CI behind a single page while giving the legacy actions a first-class sidebar section, conflicting with the recommendation in the legacy index page itself; this PR aligns navigation with the recommended path and makes the deprecated material reachable but de-emphasized.

references

Summary by CodeRabbit

  • New Features

    • describe affected --format=matrix now auto-writes matrix output to $GITHUB_OUTPUT in CI when enabled (explicit --output-file still wins); workflow examples updated.
  • Documentation

    • Added a comprehensive "Native CI for GitHub Actions" guide, updated many docs and blog posts to use native CI wording, and published a blog post about the matrix auto-output behavior.
    • Marked legacy GitHub Actions wrapper actions/pages as deprecated with warning guidance.
  • Chores

    • Added legacy URL redirects and a new "Deprecated" docs section.

…ctions

Move six legacy Cloud Posse GitHub Action docs to website/docs/deprecated/github-actions/
with deprecation banners, and rebuild website/docs/ci/ci.mdx around real example
workflows from cloudposse-examples/atmos-native-ci and atmos-native-ci-advanced
(deploy on PR, deploy on merge, preview cleanup, affected-matrix fan-out). Add
client-redirects from all six legacy /integrations/github-actions/* URLs to /ci,
add a "Deprecated" sidebar sub-category under Resources, and repoint cross-links
across docs, blog posts, and the roadmap.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@osterman osterman requested a review from a team as a code owner April 28, 2026 20:05
@atmos-pro
Copy link
Copy Markdown
Contributor

atmos-pro Bot commented Apr 28, 2026

Tip

Atmos Pro  

No affected stacks workflow was detected for this pull request.
If this is expected, no action is needed.
Learn More.

View pull request changes on Atmos Pro

@github-actions github-actions Bot added the size/m Medium size PR label Apr 28, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Apr 28, 2026

Dependency Review

✅ No vulnerabilities or license issues found.

Scanned Files

None

@mergify
Copy link
Copy Markdown

mergify Bot commented Apr 28, 2026

Important

Cloud Posse Engineering Team Review Required

This pull request modifies files that require Cloud Posse's review. Please be patient, and a core maintainer will review your changes.

To expedite this process, reach out to us on Slack in the #pr-reviews channel.

@mergify mergify Bot added the needs-cloudposse Needs Cloud Posse assistance label Apr 28, 2026
…ld patterns

Strip the GitHub Actions Workflows section down to the core pattern (checkout
then run atmos terraform plan/apply/deploy), and link out to the example repos
for use-case-specific design patterns like preview environments, image
promotion, and label gating. Examples no longer carry ECS-specific env vars
(APP_IMAGE, PR_NUMBER) or test/build prerequisites that confused the core
pattern.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 28, 2026

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review
📝 Walkthrough

Walkthrough

Replaces many /integrations/github-actions references with a new native CI /ci guide, adds comprehensive native GitHub Actions docs and redirects, marks legacy GitHub Action wrapper pages as deprecated, and implements CI-aware $GITHUB_OUTPUT auto-detection for atmos describe affected --format=matrix with tests and docs.

Changes

Cohort / File(s) Summary
Native CI guide
website/docs/ci/ci.mdx
Adds native GitHub Actions CI documentation: permissions matrix, OIDC/auth, workflow examples, deploy/affected matrix patterns, and deprecation callout for legacy actions.
Describe affected / matrix output
internal/exec/describe_affected.go, internal/exec/describe_affected_test.go, website/docs/cli/commands/describe/describe-affected.mdx, website/blog/2026-04-28-describe-affected-matrix-auto-output.mdx
Implements CI-aware auto-detection of $GITHUB_OUTPUT when ci.enabled is true for --format=matrix; updates tests, docs, and workflow examples; explicit --output-file still takes precedence.
Deprecation pages
website/docs/deprecated/github-actions/*.mdx
Marks legacy GitHub Actions wrapper pages as deprecated, adds warnings, updates links to deprecated routes, and maps native CLI equivalents.
Site-wide link & copy updates
website/docs/... (many MDX), website/blog/..., website/src/data/roadmap.js
Replaces /integrations/github-actions links with /ci or integrations index across docs and updates roadmap entries.
Redirects & sidebar
website/docusaurus.config.js, website/sidebars.js
Adds client-side redirects from legacy GitHub Actions URLs to /ci and introduces a collapsible “Deprecated” sidebar category.
Misc docs fixes
website/docs/cli/configuration/integrations/index.mdx, website/docs/components/terraform/stack-config.mdx, website/docs/deploy/deploy.mdx, website/docs/intro/*.mdx, website/docs/quick-start/*, website/docs/learn/*, website/docs/stacks/settings/depends_on.mdx, website/docs/vendor/vendor.mdx
Small copy/link adjustments pointing to /ci or integrations index; clarifies dependency-order handling in workflows.

Sequence Diagram(s)

sequenceDiagram
  participant Dev as Developer
  participant GH as GitHub Actions (CI)
  participant Atmos as Atmos CLI
  participant FS as Filesystem ($GITHUB_OUTPUT)

  Dev->>GH: Push / open PR triggers workflow
  GH->>Atmos: Run "atmos describe affected --format=matrix" (ci.enabled: true)
  Atmos->>FS: Resolve output path -> explicit --output-file OR detect $GITHUB_OUTPUT if present
  Atmos->>FS: Write matrix JSON to resolved path
  GH->>GH: Read matrix from $GITHUB_OUTPUT and expand matrix jobs
  GH->>Atmos: Run per-job "atmos terraform plan/apply"
  Atmos->>Dev: Emit logs/status
Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

Suggested reviewers

  • aknysh
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: refresh CI page with native CI workflows; deprecate legacy GH Actions' directly and clearly summarizes the main changes: refreshing CI documentation and deprecating GitHub Actions.
Docstring Coverage ✅ Passed Docstring coverage is 100.00% which is sufficient. The required threshold is 80.00%.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch osterman/ci-docs-refresh

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 6

🧹 Nitpick comments (1)
website/docs/cli/commands/describe/describe-affected.mdx (1)

85-86: Document --output-file in the Flags section for consistency.

Line 86 introduces a key CI flag pattern, but the Flags table nearby centers on --file. Add an explicit --output-file entry (or a note explaining when to use each) to avoid ambiguity.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@website/docs/cli/commands/describe/describe-affected.mdx` around lines 85 -
86, Add an explicit Flags entry for the --output-file flag (or a short
clarifying note comparing --output-file vs --file) to the Flags table near the
existing --file entry: document the flag name (--output-file), its purpose
(write machine-readable/matrix output for CI), expected value (path or
$GITHUB_OUTPUT), and example usage (e.g., atmos describe affected
--format=matrix --output-file=$GITHUB_OUTPUT) so readers aren’t left to infer
which flag to use in CI workflows.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@website/docs/deploy/deploy.mdx`:
- Line 38: The docs sentence about GitHub Actions claiming dependency ordering
"must be enforced manually" is incorrect; update the line containing "[GitHub
Actions](/ci)" to state that Atmos can enforce dependency order via CLI/command
behaviors (e.g., dependency-aware deploy modes), and add a short example or link
to the corresponding CLI docs/example that demonstrates dependency-aware deploy
behavior so website docs and CLI docs are kept in sync.

In `@website/docs/deprecated/github-actions/affected-stacks.mdx`:
- Line 113: The user-facing product name is mis-capitalized: change the link
text "[Github Actions](/deprecated/github-actions/)" to "[GitHub
Actions](/deprecated/github-actions/)" in the sentence "This action has the
requirements as [Github Actions](/deprecated/github-actions/)." Update the
display text only (keep the existing URL), and scan the same document for any
other instances of "Github" to correct to "GitHub" for consistency.

In `@website/docs/deprecated/github-actions/atmos-terraform-apply.mdx`:
- Line 62: The sentence "This action has the requirements as [Github
Actions](/deprecated/github-actions/). Use the same S3 Bucket, DynamoDB table,
IAM Roles and config described there." uses incorrect capitalization and is
awkward; update the link text from "Github Actions" to "GitHub Actions" and
rephrase the sentence for clarity (suggested rewrite: "This action has the same
requirements as GitHub Actions; use the same S3 bucket, DynamoDB table, IAM
roles, and config described there.") so change the link label and adjust casing
of "Bucket"/"Roles"/"config" to lowercase for consistency.

In `@website/docs/deprecated/github-actions/atmos-terraform-drift-detection.mdx`:
- Line 158: Replace the user-facing link label "Github Actions" with the
official casing "GitHub Actions" in the sentence containing the link ([Github
Actions](/deprecated/github-actions/)), i.e. update the link text to "[GitHub
Actions]" while leaving the URL path unchanged; also scan the same document for
any other occurrences of "Github" and correct them to "GitHub" to keep casing
consistent.

In
`@website/docs/deprecated/github-actions/atmos-terraform-drift-remediation.mdx`:
- Line 18: Replace the two wording typos by updating the exact strings: change
the possessive contraction "it's" to the correct possessive "its" wherever the
sentence "This action is used for drift remediation together with it's
[companion action..." appears, and change the product name "Github" to the
correct casing "GitHub" for the occurrence currently written as "Github"; ensure
both replacements preserve surrounding punctuation and link text.

In `@website/sidebars.js`:
- Around line 509-520: The 'Deprecated' category (label 'Deprecated', items: {
type: 'autogenerated', dirName: 'deprecated' }) is being alphabetically sorted
by the sidebar generator so it won't stay at the bottom; fix by either (A)
explicitly placing the deprecated items after the glossary in the top-level
sidebars items array instead of appending a standalone autogenerated category,
or (B) disable/override the default sort by providing a custom
sidebarItemsGenerator/sidebar sort function in the site config so the insertion
order is preserved; update the code that creates the 'Deprecated' category (the
object with label 'Deprecated' and dirName 'deprecated') accordingly.

---

Nitpick comments:
In `@website/docs/cli/commands/describe/describe-affected.mdx`:
- Around line 85-86: Add an explicit Flags entry for the --output-file flag (or
a short clarifying note comparing --output-file vs --file) to the Flags table
near the existing --file entry: document the flag name (--output-file), its
purpose (write machine-readable/matrix output for CI), expected value (path or
$GITHUB_OUTPUT), and example usage (e.g., atmos describe affected
--format=matrix --output-file=$GITHUB_OUTPUT) so readers aren’t left to infer
which flag to use in CI workflows.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 389bd5b5-9ebc-419e-b8ed-cb524af33f3d

📥 Commits

Reviewing files that changed from the base of the PR and between 9536254 and 802be41.

📒 Files selected for processing (27)
  • website/blog/2025-12-15-list-affected-command.mdx
  • website/blog/2026-02-08-describe-affected-deleted-detection.mdx
  • website/docs/ci/ci.mdx
  • website/docs/cli/commands/describe/describe-affected.mdx
  • website/docs/cli/configuration/integrations/index.mdx
  • website/docs/components/terraform/stack-config.mdx
  • website/docs/deploy/deploy.mdx
  • website/docs/deprecated/github-actions/affected-stacks.mdx
  • website/docs/deprecated/github-actions/atmos-terraform-apply.mdx
  • website/docs/deprecated/github-actions/atmos-terraform-drift-detection.mdx
  • website/docs/deprecated/github-actions/atmos-terraform-drift-remediation.mdx
  • website/docs/deprecated/github-actions/atmos-terraform-plan.mdx
  • website/docs/deprecated/github-actions/github-actions.mdx
  • website/docs/intro/faq.mdx
  • website/docs/intro/features.mdx
  • website/docs/intro/index.mdx
  • website/docs/intro/why-atmos/nirvana.mdx
  • website/docs/intro/why-atmos/stage-7.mdx
  • website/docs/learn/mindset.mdx
  • website/docs/quick-start/advanced/next-steps.md
  • website/docs/quick-start/simple/configure-cli.mdx
  • website/docs/quick-start/simple/summary.mdx
  • website/docs/stacks/settings/depends_on.mdx
  • website/docs/vendor/vendor.mdx
  • website/docusaurus.config.js
  • website/sidebars.js
  • website/src/data/roadmap.js

Comment thread website/docs/deploy/deploy.mdx Outdated
Comment thread website/docs/deprecated/github-actions/affected-stacks.mdx Outdated
Comment thread website/docs/deprecated/github-actions/atmos-terraform-apply.mdx Outdated
Comment thread website/docs/deprecated/github-actions/atmos-terraform-drift-detection.mdx Outdated
Comment thread website/docs/deprecated/github-actions/atmos-terraform-drift-remediation.mdx Outdated
Comment thread website/sidebars.js
osterman and others added 2 commits April 28, 2026 15:17
… published)

We don't publish a latest tag for ghcr.io/cloudposse/atmos. Match the
convention used by the cloudposse-examples/atmos-native-ci{,-advanced}
reference repos and pin via a repository variable.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Direct \${{ matrix.* }} interpolation inside a run: step is a GitHub Actions
script injection risk. Bind to env vars first and quote the shell expansion.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

♻️ Duplicate comments (1)
website/docs/deprecated/github-actions/affected-stacks.mdx (1)

113-113: ⚠️ Potential issue | 🟡 Minor

Fix product capitalization on Line 113.

Use GitHub (capital “H”) in the link text for user-facing consistency.

✏️ Suggested patch
-This action has the requirements as [Github Actions](/deprecated/github-actions/). Use the same config described there.
+This action has the requirements as [GitHub Actions](/deprecated/github-actions/). Use the same config described there.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@website/docs/deprecated/github-actions/affected-stacks.mdx` at line 113,
Update the user-facing link text on the sentence "This action has the
requirements as [Github Actions](/deprecated/github-actions/)." to use correct
product capitalization by changing "Github" to "GitHub" (i.e., "GitHub Actions")
so the link reads "[GitHub Actions](/deprecated/github-actions/)" and preserve
the existing URL and surrounding sentence text.
🧹 Nitpick comments (1)
website/docs/ci/ci.mdx (1)

162-162: Clarify matrix payload shape on Line 162.

--format=matrix includes component_path and component_type in addition to component and stack; consider reflecting that to avoid under-documenting available fields.

As per coding guidelines: "Keep CLI documentation and website documentation in sync and document new features on the website with examples and use cases."

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@website/docs/ci/ci.mdx` at line 162, The docs sentence about the affected
job's matrix is incomplete: update the text that currently says "The `affected`
job emits a matrix of `{component, stack}` pairs; the `deploy` job spreads
across them in parallel." to list the full payload emitted by `--format=matrix`
(include `component`, `stack`, `component_path`, and `component_type`) and add a
short example or note showing the matrix shape so readers and the `deploy` job
users know all available fields; reference the `affected` job, the `deploy` job,
and the `--format=matrix` flag when making this edit.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@website/docs/ci/ci.mdx`:
- Line 123: Update the sentence to state that semantic drift comparison is
opt-in and experimental: mention that the comparison is performed by
VerifyPlanfile() and is enabled only when the VerifyPlan CLI flag (handled in
the Terraform CLI handler) or the `--verify-plan` option is provided, and mark
the feature as experimental. Ensure the phrasing clearly indicates it is not
automatic during deploy but requires the `--verify-plan` flag and is under
active development.

---

Duplicate comments:
In `@website/docs/deprecated/github-actions/affected-stacks.mdx`:
- Line 113: Update the user-facing link text on the sentence "This action has
the requirements as [Github Actions](/deprecated/github-actions/)." to use
correct product capitalization by changing "Github" to "GitHub" (i.e., "GitHub
Actions") so the link reads "[GitHub Actions](/deprecated/github-actions/)" and
preserve the existing URL and surrounding sentence text.

---

Nitpick comments:
In `@website/docs/ci/ci.mdx`:
- Line 162: The docs sentence about the affected job's matrix is incomplete:
update the text that currently says "The `affected` job emits a matrix of
`{component, stack}` pairs; the `deploy` job spreads across them in parallel."
to list the full payload emitted by `--format=matrix` (include `component`,
`stack`, `component_path`, and `component_type`) and add a short example or note
showing the matrix shape so readers and the `deploy` job users know all
available fields; reference the `affected` job, the `deploy` job, and the
`--format=matrix` flag when making this edit.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 7fd10aa4-fff8-4850-8860-f52ad4eaaf1e

📥 Commits

Reviewing files that changed from the base of the PR and between 802be41 and 2ef5579.

📒 Files selected for processing (3)
  • website/docs/ci/ci.mdx
  • website/docs/cli/commands/describe/describe-affected.mdx
  • website/docs/deprecated/github-actions/affected-stacks.mdx

Comment thread website/docs/ci/ci.mdx Outdated
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 28, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 77.97%. Comparing base (9536254) to head (a3e7862).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #2373      +/-   ##
==========================================
+ Coverage   77.94%   77.97%   +0.02%     
==========================================
  Files        1090     1090              
  Lines      103072   103075       +3     
==========================================
+ Hits        80344    80371      +27     
+ Misses      18320    18295      -25     
- Partials     4408     4409       +1     
Flag Coverage Δ
unittests 77.97% <100.00%> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines Coverage Δ
internal/exec/describe_affected.go 79.06% <100.00%> (+0.22%) ⬆️

... and 5 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

…nabled

`atmos describe affected --format=matrix` now writes to $GITHUB_OUTPUT
automatically when ci.enabled is true, matching the existing behavior of
`atmos list instances --format=matrix` (pkg/list/list_instances.go:649-652).
The explicit --output-file=$GITHUB_OUTPUT flag is no longer required in
GitHub Actions workflow YAML.

Also expands the /ci page with:
- Permissions table mapping native CI features to GitHub Actions scopes
- Per-workflow permission blocks (statuses:write, checks:write, etc.)
- Deploy Affected and Deploy All workflow examples (no --output-file)
- Authentication walkthrough: define github profile, OIDC provider,
  identity selection (default / per-component / inheritance), no
  separate atmos auth login step in CI
- GitHub Environments section for prod gating

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
internal/exec/describe_affected.go (1)

367-370: Use request-scoped CI config for matrix auto-output gating.

On Line 368, the CI check uses d.atmosConfig.CI.Enabled, while the command execution is driven by a (including a.CLIConfig). Using a.CLIConfig here keeps behavior consistent per invocation and avoids subtle config drift if executor state and args ever diverge.

Patch
-		outputFile := a.GithubOutputFile
-		if outputFile == "" && d.atmosConfig.CI.Enabled {
+		outputFile := a.GithubOutputFile
+		if outputFile == "" && a.CLIConfig != nil && a.CLIConfig.CI.Enabled {
 			outputFile = ghactions.GetOutputPath()
 		}
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@internal/exec/describe_affected.go` around lines 367 - 370, The CI gating
check should use the request-scoped CLI config instead of the executor-level
config: change the condition that reads d.atmosConfig.CI.Enabled to reference
a.CLIConfig.CI.Enabled so the outputFile selection (around variables outputFile
and a.GithubOutputFile) follows the invocation-specific settings from
a.CLIConfig; update that single conditional to use a.CLIConfig.CI.Enabled to
avoid config drift between executor state and per-request args.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@internal/exec/describe_affected.go`:
- Around line 367-370: The CI gating check should use the request-scoped CLI
config instead of the executor-level config: change the condition that reads
d.atmosConfig.CI.Enabled to reference a.CLIConfig.CI.Enabled so the outputFile
selection (around variables outputFile and a.GithubOutputFile) follows the
invocation-specific settings from a.CLIConfig; update that single conditional to
use a.CLIConfig.CI.Enabled to avoid config drift between executor state and
per-request args.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 6c7fb56c-ac39-47c1-a5a8-af17afe6b321

📥 Commits

Reviewing files that changed from the base of the PR and between 8eb4c21 and d6951c1.

📒 Files selected for processing (7)
  • internal/exec/describe_affected.go
  • internal/exec/describe_affected_test.go
  • website/blog/2026-04-28-describe-affected-matrix-auto-output.mdx
  • website/docs/ci/ci.mdx
  • website/docs/cli/commands/describe/describe-affected.mdx
  • website/docs/deprecated/github-actions/affected-stacks.mdx
  • website/src/data/roadmap.js
🚧 Files skipped from review as they are similar to previous changes (1)
  • website/src/data/roadmap.js

Clarify that semantic plan verification on `atmos terraform deploy` is
opt-in via `--verify-plan` and experimental. Correct the dependency-
ordering claim for GitHub Actions to point at `terraform deploy --affected`.
Fix `Github` -> `GitHub` and `it's` -> `its` typos carried over into the
deprecated GitHub Actions wrapper docs.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

♻️ Duplicate comments (3)
website/docs/deprecated/github-actions/atmos-terraform-apply.mdx (2)

11-11: ⚠️ Potential issue | 🟡 Minor

Clarify that deploy drift verification is opt-in.

Line 11 reads like verification is automatic on atmos terraform deploy; it should state this is enabled with --verify-plan (experimental).

Suggested patch
-This GitHub Action is deprecated. New projects should use [native CI integration](/ci) — `atmos terraform apply` (or `atmos terraform deploy`, which adds drift verification) handles planfile retrieval, semantic diff, and CI artifacts directly without a wrapper action.
+This GitHub Action is deprecated. New projects should use [native CI integration](/ci) — `atmos terraform apply` (or `atmos terraform deploy` with optional `--verify-plan` for experimental semantic verification) handles planfile retrieval and CI artifacts directly without a wrapper action.
As per coding guidelines: "Keep CLI documentation and website documentation in sync and document new features on the website with examples and use cases."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@website/docs/deprecated/github-actions/atmos-terraform-apply.mdx` at line 11,
Update the sentence mentioning "atmos terraform deploy" to state that drift
verification is opt-in and must be enabled with the experimental flag
`--verify-plan`; specifically change the phrasing around the CLI reference so it
reads something like "`atmos terraform deploy` (which can add drift verification
when run with the experimental `--verify-plan` flag)..." to make clear
verification is not automatic; ensure the `--verify-plan` flag and
"(experimental)" are included near the `atmos terraform deploy` mention.

62-62: ⚠️ Potential issue | 🟡 Minor

Tighten the requirements sentence for readability and style consistency.

Line 62 still reads awkwardly and uses inconsistent capitalization for common nouns.

Suggested patch
-This action has the requirements as [GitHub Actions](/deprecated/github-actions/). Use the same S3 Bucket, DynamoDB table, IAM Roles and config described there.
+This action has the same requirements as [GitHub Actions](/deprecated/github-actions/). Use the same S3 bucket, DynamoDB table, IAM roles, and config described there.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@website/docs/deprecated/github-actions/atmos-terraform-apply.mdx` at line 62,
Rewrite the awkward sentence that begins "This action has the requirements as
[GitHub Actions]" to improve readability and lowercase common nouns
consistently; replace it with a clearer line such as: "This action has the same
requirements as [GitHub Actions]: use the same S3 bucket, DynamoDB table, IAM
roles, and configuration described there." Update the link text "[GitHub
Actions]" and the nouns "S3 Bucket", "DynamoDB table", "IAM Roles" and "config"
to use consistent casing (e.g., "S3 bucket", "DynamoDB table", "IAM roles",
"configuration") in the same sentence.
website/docs/deprecated/github-actions/atmos-terraform-drift-detection.mdx (1)

158-158: ⚠️ Potential issue | 🟡 Minor

Polish the requirements sentence for clarity and consistency.

Line 158 has the same awkward phrasing/capitalization pattern previously flagged.

Suggested patch
-This action has the requirements as [GitHub Actions](/deprecated/github-actions/). Use the same S3 Bucket, DynamoDB table, IAM Roles and config described there.
+This action has the same requirements as [GitHub Actions](/deprecated/github-actions/). Use the same S3 bucket, DynamoDB table, IAM roles, and config described there.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@website/docs/deprecated/github-actions/atmos-terraform-drift-detection.mdx`
at line 158, Reword the requirements sentence to be clearer and consistent:
replace "This action has the requirements as [GitHub
Actions](/deprecated/github-actions/). Use the same S3 Bucket, DynamoDB table,
IAM Roles and config described there." with a polished sentence such as "This
action has the same requirements as the GitHub Actions guide: use the same S3
bucket, DynamoDB table, IAM roles, and configuration described there." Ensure
consistent capitalization (lowercase "bucket", "table", "roles",
"configuration") and parallel list punctuation.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@website/docs/deprecated/github-actions/atmos-terraform-apply.mdx`:
- Line 44: The sentence currently reads “plan all affected stacks” but this page
describes the apply action; update the wording to “apply all affected stacks”
(or similar: “apply all affected stacks in parallel”) so it matches the
atmos-terraform-apply action and the referenced [`affected-stacks`] GitHub
Action; ensure the rest of the sentence/context still reads correctly after
replacing “plan” with “apply.”

---

Duplicate comments:
In `@website/docs/deprecated/github-actions/atmos-terraform-apply.mdx`:
- Line 11: Update the sentence mentioning "atmos terraform deploy" to state that
drift verification is opt-in and must be enabled with the experimental flag
`--verify-plan`; specifically change the phrasing around the CLI reference so it
reads something like "`atmos terraform deploy` (which can add drift verification
when run with the experimental `--verify-plan` flag)..." to make clear
verification is not automatic; ensure the `--verify-plan` flag and
"(experimental)" are included near the `atmos terraform deploy` mention.
- Line 62: Rewrite the awkward sentence that begins "This action has the
requirements as [GitHub Actions]" to improve readability and lowercase common
nouns consistently; replace it with a clearer line such as: "This action has the
same requirements as [GitHub Actions]: use the same S3 bucket, DynamoDB table,
IAM roles, and configuration described there." Update the link text "[GitHub
Actions]" and the nouns "S3 Bucket", "DynamoDB table", "IAM Roles" and "config"
to use consistent casing (e.g., "S3 bucket", "DynamoDB table", "IAM roles",
"configuration") in the same sentence.

In `@website/docs/deprecated/github-actions/atmos-terraform-drift-detection.mdx`:
- Line 158: Reword the requirements sentence to be clearer and consistent:
replace "This action has the requirements as [GitHub
Actions](/deprecated/github-actions/). Use the same S3 Bucket, DynamoDB table,
IAM Roles and config described there." with a polished sentence such as "This
action has the same requirements as the GitHub Actions guide: use the same S3
bucket, DynamoDB table, IAM roles, and configuration described there." Ensure
consistent capitalization (lowercase "bucket", "table", "roles",
"configuration") and parallel list punctuation.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: bd525756-6016-441a-8dac-48176e84fbac

📥 Commits

Reviewing files that changed from the base of the PR and between d6951c1 and 417b82b.

📒 Files selected for processing (6)
  • website/docs/ci/ci.mdx
  • website/docs/deploy/deploy.mdx
  • website/docs/deprecated/github-actions/affected-stacks.mdx
  • website/docs/deprecated/github-actions/atmos-terraform-apply.mdx
  • website/docs/deprecated/github-actions/atmos-terraform-drift-detection.mdx
  • website/docs/deprecated/github-actions/atmos-terraform-drift-remediation.mdx
✅ Files skipped from review due to trivial changes (2)
  • website/docs/deprecated/github-actions/affected-stacks.mdx
  • website/docs/deprecated/github-actions/atmos-terraform-drift-remediation.mdx

Comment thread website/docs/deprecated/github-actions/atmos-terraform-apply.mdx Outdated
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
osterman and others added 2 commits April 28, 2026 19:55
`atmos terraform deploy` runs a fresh plan+apply with -auto-approve.
The stored planfile from the PR is only consulted when --verify-plan
is passed. Also note that `atmos terraform apply` is a valid alternative.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
coderabbitai[bot]
coderabbitai Bot previously approved these changes Apr 29, 2026
Lead with the container-based approach (image: ghcr.io/cloudposse/atmos:...)
and frame the setup-atmos action as the alternative for cases where the
container doesn't fit (other tools needed, self-hosted runners, etc).
Cross-link to /ci for end-to-end native CI patterns.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
The GitHub Actions sidebar section listed only Component Updater and
Setup Atmos. Add a top entry pointing to Native CI (/ci) so readers
browsing the GH Actions section can discover the recommended workflow
patterns.

Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
@aknysh aknysh merged commit 8965bc6 into main Apr 29, 2026
59 checks passed
@atmos-pro
Copy link
Copy Markdown
Contributor

atmos-pro Bot commented Apr 29, 2026

Note

Atmos Pro  

Waiting for your GitHub Actions workflow to upload affected stacks.
Learn More.

@aknysh aknysh deleted the osterman/ci-docs-refresh branch April 29, 2026 14:59
@mergify mergify Bot removed the needs-cloudposse Needs Cloud Posse assistance label Apr 29, 2026
@atmos-pro
Copy link
Copy Markdown
Contributor

atmos-pro Bot commented Apr 29, 2026

Note

Atmos Pro  

Waiting for your GitHub Actions workflow to upload affected stacks.
Learn More.

@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 2, 2026

These changes were released in v1.217.0-rc.3.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

no-release Do not create a new release (wait for additional code changes) size/m Medium size PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants