fix: Replacing usage of run-all with run --all in starlight docs
#3950
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe documentation has been updated to reflect a new command syntax for Terragrunt operations. All examples previously using Changes
Possibly related PRs
Suggested reviewers
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![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 (3)
docs-starlight/src/content/docs/02-features/02-stacks.mdx (3)
89-89: Updated Text for Output Command
The updated sentence instructs users how to view outputs using therun --all outputcommand.
Note: A minor stylistic suggestion – consider trimming the phrase “of all of the subfolders” to “for all subfolders” for conciseness.🧰 Tools
🪛 LanguageTool
[style] ~89-~89: Consider removing “of” to be more concise
Context: ...To see the currently applied outputs of all of the subfolders, you can use therun --all...(ALL_OF_THE)
96-96: Revised Text for Plan Evaluation Guidance
The updated line introduces the plan command replacement. It might be worth rewording “if you make some changes to your project” to something like “if you update your project” for added clarity and a stronger tone.🧰 Tools
🪛 LanguageTool
[style] ~96-~96: Consider rephrasing this to strengthen your wording.
Context: ...t run --all output ``` Finally, if you make some changes to your project, you could evaluate the...(MAKE_CHANGES)
195-195: Clarification on Dependency Limitations in Plan/Validate
This block explains the issues when running commands that do not modify state in a new setup. It’s informative and precise.
Suggestion: Consider using “entirely new setup” instead of “completely new setup” to enhance clarity, as suggested by static analysis.🧰 Tools
🪛 LanguageTool
[style] ~195-~195: Consider using a different adverb to strengthen your wording.
Context: ...-all planandrun --all validate`) on a completely new setup where no infrastructure has b...(COMPLETELY_ENTIRELY)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs-starlight/src/content/docs/02-features/02-stacks.mdx(14 hunks)
🧰 Additional context used
🪛 LanguageTool
docs-starlight/src/content/docs/02-features/02-stacks.mdx
[style] ~89-~89: Consider removing “of” to be more concise
Context: ...To see the currently applied outputs of all of the subfolders, you can use the run --all...
(ALL_OF_THE)
[style] ~96-~96: Consider rephrasing this to strengthen your wording.
Context: ...t run --all output ``` Finally, if you make some changes to your project, you could evaluate the...
(MAKE_CHANGES)
[style] ~195-~195: Consider using a different adverb to strengthen your wording.
Context: ...-all planandrun --all validate`) on a completely new setup where no infrastructure has b...
(COMPLETELY_ENTIRELY)
[style] ~197-~197: Consider using a different adverb to strengthen your wording.
Context: ... --all validateorrun --all plan` on a completely new set of infrastructure. To address ...
(COMPLETELY_ENTIRELY)
[uncategorized] ~199-~199: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...utsattribute on thedependency` block and it corresponds to a map that will be in...
(COMMA_COMPOUND_SENTENCE)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: build-and-test
- GitHub Check: unessential
🔇 Additional comments (16)
docs-starlight/src/content/docs/02-features/02-stacks.mdx (16)
73-73: Update to Introductory Text for Apply Command
The revised sentence clearly instructs users to navigate into therootdirectory and deploy all units using therun --allcommand withapply. This update correctly replaces the old syntax with the new one.
77-77: Corrected Apply Command Example
The code snippet now showsterragrunt run --all apply, which is exactly what we need. Clean and to the point!
82-82: Updated Text for Destroy Command Introduction
The modified line now explains that to undeploy all units, the updated commandrun --all destroyshould be used. It’s consistent with the new syntax.
86-86: Corrected Destroy Command Example
The snippet now properly usesterragrunt run --all destroy. This change aligns perfectly with the documentation update.
93-93: Corrected Output Command Example
The code block now showsterragrunt run --all outputcorrectly.
105-105: Corrected Plan Command Example
The snippet now accurately reflects the new syntax:terragrunt run --all plan.
203-203: Example Update for Mock Outputs Scenario
The sentence now clearly illustrates how amysqlunit can mock thevpc_idduring arun --all validateoperation. This example adds value and clarity for users.
245-245: Clarification on When Mock Outputs are Used
This update correctly notes that themock_outputswill be applied during bothvalidateandrun --all validate. It’s clear and useful information.
345-345: Explaining the Order of Execution
The revised line clearly introduces the order of runs for therun --all applycommand based on dependency relationships. This is informative and consistent.
387-387: Updated Command with Source Parameter (Plan)
The code snippet now correctly showsterragrunt run --all plan --source /source/modules, matching the PR objectives for updating command syntax.
411-411: Updated Command with Source Parameter (Apply)
The example is now updated to useterragrunt run --all apply --source /source/infrastructure-modules, which is spot on.
464-465: Updated Commands for Plan-Destroy Workflow
Both commands in this code block, for planning a destroy operation and then applying it, now use the updated syntax along with the--out-dirflag correctly.
471-471: Updated JSON Plan Command Example
The snippet now showsterragrunt run --all --json-out-dir /tmp/json plan, which fits the updated docs perfectly.
515-515: Note on JSON Plan Files
The note clearly states the limitation: JSON plan files cannot be used with therun --all applycommand. It’s a necessary caution for users.
543-543: Clarification on Running Commands in Nested Stacks
The updated sentence now explains thatrun --allcommands can be executed at any depth within a stack. This makes the concept of nested stacks more accessible.
549-549: Nested Stack Command Example
The final code block shows the updated syntaxterragrunt run --all applyfor executing commands in a nested stack scenario. It’s concise and correct.
Description
We have the
run --allcommand now, and the starlight docs are supposed to represent where the docs will be at 1.0, so we can update them accordingly now.TODOs
Read the Gruntwork contribution guidelines.
Release Notes (draft)
Added / Removed / Updated [X].
Migration Guide
Summary by CodeRabbit