Skip to content

Conversation

@josh-padnick
Copy link
Contributor

@josh-padnick josh-padnick commented Oct 8, 2025

Summary by CodeRabbit

  • Documentation
    • Clarified Terragrunt lifecycle guidance by replacing a single generic “run-all” instruction with explicit steps: “run-all plan,” “run-all apply,” and “run-all destroy,” improving readability and user flow.
    • Minor text churn in the CI/CD section with no content change or user impact.

@vercel
Copy link

vercel bot commented Oct 8, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
docs Ready Ready Preview Comment Oct 8, 2025 7:41pm

@josh-padnick josh-padnick changed the title Modernize Terragrunt commands Update Pipelines overview to use modern Terragrunt commands Oct 8, 2025
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 8, 2025

Walkthrough

Documentation update clarifying Terragrunt run-all usage by splitting a single bullet into explicit subcommands (plan, apply, destroy). One line in the CI/CD section was removed and re-added without textual changes.

Changes

Cohort / File(s) Summary
Documentation: Terragrunt lifecycle bullets
docs/2.0/docs/pipelines/concepts/overview.md
Replaced a single “terragrunt run-all” bullet with three explicit bullets: “run-all plan”, “run-all apply”, “run-all destroy”. Also saw a delete-and-reinsert of an identical line in the CI/CD section with no net textual change.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

Three steps march where one once stood—
plan whispers “preview,” apply knocks wood,
destroy clears paths as forests should.
A doc’s small nudge, a cleaner guide,
pipelines read, and choices ride.
Click, commit—clarity applied.

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title Check ✅ Passed The title concisely and accurately summarizes the primary documentation change by indicating that the pipelines overview is being updated to use modern Terragrunt commands, directly reflecting the switch from a single aggregated command to explicit subcommands.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch josh-padnick-patch-4

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
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

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6531135 and f30a1cd.

📒 Files selected for processing (1)
  • docs/2.0/docs/pipelines/concepts/overview.md (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: ZachGoldberg
PR: gruntwork-io/docs#2663
File: docs/2.0/docs/pipelines/architecture/change-types.md:59-61
Timestamp: 2025-07-17T18:44:16.153Z
Learning: In current Terragrunt versions (2024-2025), the preferred command syntax is `terragrunt run --all` rather than the deprecated `terragrunt run-all` subcommand. The `run-all` command is still functional for backwards compatibility but is being phased out in favor of the `run --all` syntax.
📚 Learning: 2025-07-17T18:44:16.153Z
Learnt from: ZachGoldberg
PR: gruntwork-io/docs#2663
File: docs/2.0/docs/pipelines/architecture/change-types.md:59-61
Timestamp: 2025-07-17T18:44:16.153Z
Learning: In current Terragrunt versions (2024-2025), the preferred command syntax is `terragrunt run --all` rather than the deprecated `terragrunt run-all` subcommand. The `run-all` command is still functional for backwards compatibility but is being phased out in favor of the `run --all` syntax.

Applied to files:

  • docs/2.0/docs/pipelines/concepts/overview.md
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
  • GitHub Check: Validate generated content
  • GitHub Check: validate_build

Comment on lines 17 to +22
- `terragrunt plan`
- `terragrunt apply`
- `terragrunt destroy`
- `terragrunt run-all`
- `terragrunt run-all plan`
- `terragrunt run-all apply`
- `terragrunt run-all destroy`
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major

Update to the current terragrunt run --all syntax

The bullets still reference the deprecated run-all subcommand. To keep the docs aligned with modern Terragrunt usage, please switch these examples to terragrunt run --all plan|apply|destroy (matching the CLI evolution noted earlier).
Based on learnings

🤖 Prompt for AI Agents
In docs/2.0/docs/pipelines/concepts/overview.md around lines 17 to 22, the
examples use the deprecated terragrunt subcommand "run-all"; update the three
bullets that list "terragrunt run-all plan", "terragrunt run-all apply", and
"terragrunt run-all destroy" to the current syntax "terragrunt run --all plan",
"terragrunt run --all apply", and "terragrunt run --all destroy" (or a single
combined example shown as "terragrunt run --all plan|apply|destroy"), ensuring
spacing and hyphenation match the modern CLI form used elsewhere in the docs.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants