docs: Updating migration guide for --terragrunt- flag removal
#4671
Conversation
📝 WalkthroughWalkthroughAdds a “CLI Flag Migration Table” section to two migration guide files, mapping old Terragrunt CLI flags (prefixed with --terragrunt-) to new non-prefixed equivalents. Placement is after notes about the new flag names and before environment variable guidance. No code or behavioral changes. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Possibly related PRs
Suggested reviewers
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. ✨ Finishing Touches🧪 Generate unit tests
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
Status, Documentation and Community
|
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs-starlight/src/content/docs/06-migrate/03-cli-redesign.md (1)
64-122: Call out non-trivial renames with short notes for accuracyA few mappings aren’t purely cosmetic removals of the terragrunt- prefix and may have scope/behavior nuances (e.g., debug → inputs-debug; ignore-dependency-errors → queue-ignore-errors; fail-on-state-bucket-creation → backend-require-bootstrap). Adding a brief note after the table will prevent misinterpretation.
Apply this minimal diff to add a short “Notes” section immediately after the table:
| `--terragrunt-no-destroy-dependencies-check` | `--no-destroy-dependencies-check` | | +Note: Some renames are not purely cosmetic and may differ slightly in scope or behavior: +- `--terragrunt-debug` → `--inputs-debug`: the flag now targets inputs processing rather than global debug. +- `--terragrunt-ignore-dependency-errors` → `--queue-ignore-errors`: the flag is scoped to queue/graph execution behavior. +- `--terragrunt-fail-on-state-bucket-creation` → `--backend-require-bootstrap`: explicit bootstrap is required instead of implicitly creating backend resources. +docs/_docs/06_migration_guides/03-cli-redesign.md (1)
69-127: Flag important behavior changes with brief notesA few entries are not pure prefix removals and could surprise users without context (e.g., debug → inputs-debug; ignore-dependency-errors → queue-ignore-errors; fail-on-state-bucket-creation → backend-require-bootstrap). Add a short note block right after the table.
Apply this minimal diff to include clarifying notes:
| `--terragrunt-no-destroy-dependencies-check` | `--no-destroy-dependencies-check` | | +Note: Some renames are not purely cosmetic and may differ slightly in scope or behavior: +- `--terragrunt-debug` → `--inputs-debug`: the flag now targets inputs processing rather than global debug. +- `--terragrunt-ignore-dependency-errors` → `--queue-ignore-errors`: the flag is scoped to queue/graph execution behavior. +- `--terragrunt-fail-on-state-bucket-creation` → `--backend-require-bootstrap`: explicit bootstrap is required instead of implicitly creating backend resources. +
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these settings in your CodeRabbit configuration.
📒 Files selected for processing (2)
docs-starlight/src/content/docs/06-migrate/03-cli-redesign.md(1 hunks)docs/_docs/06_migration_guides/03-cli-redesign.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs-starlight/**/*.md*
⚙️ CodeRabbit Configuration File
Review the documentation for clarity, grammar, and spelling. Make sure that the documentation is easy to understand and follow. There is currently a migration underway from the Jekyll based documentation in
docsto the Starlight + Astro based documentation indocs-starlight. Make sure that thedocs-starlightdocumentation is accurate and up-to-date with thedocsdocumentation, and that any difference between them results in an improvement in thedocs-starlightdocumentation.
Files:
docs-starlight/src/content/docs/06-migrate/03-cli-redesign.md
docs/**/*.md
⚙️ CodeRabbit Configuration File
Review the documentation for clarity, grammar, and spelling. Make sure that the documentation is easy to understand and follow. There is currently a migration underway from the Jekyll based documentation in
docsto the Starlight + Astro based documentation indocs-starlight. Whenever changes are made to thedocsdirectory, ensure that an equivalent change is made in thedocs-starlightdirectory to keep thedocs-starlightdocumentation accurate.
Files:
docs/_docs/06_migration_guides/03-cli-redesign.md
🧠 Learnings (1)
📚 Learning: 2025-04-17T13:02:28.098Z
Learnt from: yhakbar
PR: gruntwork-io/terragrunt#4169
File: cli/commands/hcl/validate/cli.go:29-60
Timestamp: 2025-04-17T13:02:28.098Z
Learning: Avoid shadowing imported packages with local variables in Go code, such as using a variable named `flags` when the `github.com/gruntwork-io/terragrunt/cli/flags` package is imported. Use more specific variable names like `flagSet` instead.
Applied to files:
docs-starlight/src/content/docs/06-migrate/03-cli-redesign.mddocs/_docs/06_migration_guides/03-cli-redesign.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). (11)
- GitHub Check: Build (darwin/amd64)
- GitHub Check: Build (linux/arm64)
- GitHub Check: Build (linux/amd64)
- GitHub Check: Test (CAS)
- GitHub Check: Test (Provider Cache Dir with Tofu)
- GitHub Check: Test (AWS with Latest Terraform)
- GitHub Check: Test (Provider Cache Server with Latest Terraform)
- GitHub Check: Test (AWS with Latest OSS Terraform)
- GitHub Check: Test (AWS Tofu)
- GitHub Check: Test (Fixtures with Latest Terraform)
- GitHub Check: Test (macos)
🔇 Additional comments (5)
docs-starlight/src/content/docs/06-migrate/03-cli-redesign.md (3)
64-122: Great addition: clear, high-signal mapping tableThe table adds immediate, practical value for users migrating from legacy flags to the new names. Placement is spot-on and formatting reads well.
64-122: CLI Flag Migration Table Verification NeededThe automated extraction script failed due to environment limitations. Please manually ensure the following before merging:
- Scan the repo for any remaining
--terragrunt-*flags (e.g.grep -R -- '--terragrunt-' .) and confirm each is listed in the migration table.- Verify every “New Flag” in the table appears in your docs/reference directories (
docs-starlight/src/content/docs/docs/referenceanddocs/_docs/06_migration_guides).- Confirm that the CLI Flag Migration Table in Starlight (
docs-starlight/.../03-cli-redesign.md) is identical to the one in Jekyll (docs/_docs/06_migration_guides/03-cli-redesign.md).
64-122:--queue-include-units-readingflag is correctly spelled and widely used
The exact flag name appears in:
cli/commands/run/flags.go(definition and deprecation alias)- Integration tests (
test/integration_units_reading_test.go)- Reference docs under
/docs/reference/cli-options/and/docs/reference/cli/commands/run- Migration guide (
docs-starlight/src/content/docs/06-migrate/03-cli-redesign.md)No typo detected—no changes needed.
docs/_docs/06_migration_guides/03-cli-redesign.md (2)
69-127: Nicely structured mapping improves the migration storyThe dedicated table is helpful and mirrors the Starlight doc, keeping both sites consistent.
69-127: Double-check--queue-include-units-readingThe “reading” suffix stands out as potentially unintended. Please validate the spelling against the CLI and reference docs, and align the table accordingly if needed.
Run the same verification script I shared in the Starlight comment from the repo root; it also checks that both tables are identical and flags missing or unused mappings.
|
what about |
Great question! It is not a CLI flag, and will not be impacted by breaking changes on the road to 1.0. We may consider deprecating the |
Description
Explicitly maps every legacy flag that's being removed to the modern equivalent.
TODOs
Read the Gruntwork contribution guidelines.
Release Notes (draft)
Added / Removed / Updated [X].
Migration Guide
Summary by CodeRabbit