docs: Adding Run Queue Docs #4249
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 WalkthroughWalkthroughThis change introduces comprehensive documentation for the "Run Queue" feature in Terragrunt, including a new page detailing its design, usage, and operational considerations. It also updates sidebar ordering for related documentation, adds the Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DocsSite
participant RunQueueDoc
User->>DocsSite: Requests "Run Queue" documentation
DocsSite->>RunQueueDoc: Loads content and diagrams
RunQueueDoc-->>DocsSite: Returns detailed explanation, flags, caveats
DocsSite-->>User: Renders "Run Queue" page with diagrams
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
✨ Finishing Touches
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 6
🧹 Nitpick comments (3)
docs/_docs/02_features/05-run-queue.md (1)
41-52: Comprehensive list of filtering options.The documentation provides a complete list of options for filtering units in the queue with clear explanations of each flag's purpose.
Consider adding one or two simple examples of how these flags might be used in practice to make the documentation even more user-friendly.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...reference/cli-options#queue-include-dir): Specify glob patterns for directories t...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~45-~45: To form a complete sentence, be sure to include a subject.
Context: ... patterns for directories to include. Can be used multiple times. - [`--queue-exc...(MISSING_IT_THERE)
[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...reference/cli-options#queue-exclude-dir): Specify glob patterns for directories t...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~46-~46: To form a complete sentence, be sure to include a subject.
Context: ... patterns for directories to exclude. Can be used multiple times. Note that depen...(MISSING_IT_THERE)
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...ference/cli-options#queue-excludes-file): Provide a file containing a list of dir...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...erence/cli-options#queue-strict-include): Only include units matching `--queue-in...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...ence/cli-options#queue-include-external): Include external dependencies (those ou...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...ence/cli-options#queue-exclude-external): Exclude external dependencies. - [`--qu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~51-~51: Loose punctuation mark.
Context: ...cli-options#queue-include-units-reading): Include units that read a specific file...(UNLIKELY_OPENING_PUNCTUATION)
docs-starlight/src/content/docs/02-features/05-run-queue.mdx (2)
13-24: Improve nested list indentation for Markdown rendering
The sub-items under step 2 use a*for bullets but aren’t indented to align under the numbered list. This may render inconsistently. For example:2. **Constructing the Queue:** … - * For commands like `plan` or `apply`… - * For commands like `destroy`… + - For commands like `plan` or `apply`… + - For commands like `destroy`…Please adjust the indent (e.g., two extra spaces) so these render as true sub-bullets.
59-71: Grammar: complete the bullet sentences in “Filtering Units”
Several bullets end with sentence fragments (“Can be used multiple times.”). For consistency, make them full sentences. Example:- [`--queue-include-dir`]: Specify glob patterns for directories to *include*. Can be used multiple times. + [`--queue-include-dir`]: Specify glob patterns for directories to *include*. It can be used multiple times.Please apply similar edits to the other list items under this section.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...ence/cli/commands/run#queue-include-dir): Specify glob patterns for directories t...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~65-~65: To form a complete sentence, be sure to include a subject.
Context: ... patterns for directories to include. Can be used multiple times. - [`--queue-e...(MISSING_IT_THERE)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...ence/cli/commands/run#queue-exclude-dir): Specify glob patterns for directories t...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~66-~66: To form a complete sentence, be sure to include a subject.
Context: ... patterns for directories to exclude. Can be used multiple times. Note that depen...(MISSING_IT_THERE)
[uncategorized] ~67-~67: Loose punctuation mark.
Context: ...ce/cli/commands/run#queue-excludes-file): Provide a file containing a list of dir...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...e/cli/commands/run#queue-strict-include): Only include units matching `--queue-in...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...cli/commands/run#queue-include-external): Include external dependencies (those ou...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~70-~70: Loose punctuation mark.
Context: ...cli/commands/run#queue-exclude-external): Exclude external dependencies. - [`--...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...ommands/run#queue-include-units-reading): Include units that read a specific file...(UNLIKELY_OPENING_PUNCTUATION)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (4)
docs-starlight/bun.lockis excluded by!**/*.lockdocs-starlight/public/d2/docs/02-features/05-run-queue-0.svgis excluded by!**/*.svgdocs-starlight/src/assets/img/d2/docs/02-features/05-run-queue-0.svgis excluded by!**/*.svgdocs/assets/img/05-run-queue-0.svgis excluded by!**/*.svg
📒 Files selected for processing (25)
docs-starlight/README.md(1 hunks)docs-starlight/astro.config.mjs(1 hunks)docs-starlight/package.json(1 hunks)docs-starlight/src/content/docs/02-features/05-run-queue.mdx(1 hunks)docs-starlight/src/content/docs/02-features/06-catalog.md(1 hunks)docs-starlight/src/content/docs/02-features/07-scaffold.md(1 hunks)docs-starlight/src/content/docs/02-features/08-extra-arguments.mdx(1 hunks)docs-starlight/src/content/docs/02-features/09-authentication.md(1 hunks)docs-starlight/src/content/docs/02-features/10-hooks.md(1 hunks)docs-starlight/src/content/docs/02-features/11-auto-init.md(1 hunks)docs-starlight/src/content/docs/02-features/12-runtime-control.md(1 hunks)docs-starlight/src/content/docs/02-features/13-provider-cache-server.md(1 hunks)docs-starlight/src/content/docs/02-features/14-engine.mdx(1 hunks)docs-starlight/src/content/docs/02-features/15-cas.md(1 hunks)docs-starlight/vercel.json(1 hunks)docs/_docs/02_features/05-run-queue.md(1 hunks)docs/_docs/02_features/06-catalog.md(1 hunks)docs/_docs/02_features/07-scaffold.md(1 hunks)docs/_docs/02_features/08-extra-arguments.md(1 hunks)docs/_docs/02_features/09-aws-authentication.md(1 hunks)docs/_docs/02_features/10-hooks.md(1 hunks)docs/_docs/02_features/12-runtime-control.md(1 hunks)docs/_docs/02_features/13-provider-cache-server.md(1 hunks)docs/_docs/02_features/14-engine.md(1 hunks)docs/_docs/02_features/15-cas.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
`docs-starlight/**/*.md*`: Review the documentation for clarity, grammar, and spelling. Make sure that the documentation is easy to understand and follow. There is currently a migr...
docs-starlight/**/*.md*: 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 indocsto 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.
docs-starlight/src/content/docs/02-features/07-scaffold.mddocs-starlight/src/content/docs/02-features/14-engine.mdxdocs-starlight/src/content/docs/02-features/12-runtime-control.mddocs-starlight/src/content/docs/02-features/15-cas.mddocs-starlight/src/content/docs/02-features/09-authentication.mddocs-starlight/src/content/docs/02-features/06-catalog.mddocs-starlight/README.mddocs-starlight/src/content/docs/02-features/08-extra-arguments.mdxdocs-starlight/src/content/docs/02-features/10-hooks.mddocs-starlight/src/content/docs/02-features/13-provider-cache-server.mddocs-starlight/src/content/docs/02-features/11-auto-init.mddocs-starlight/src/content/docs/02-features/05-run-queue.mdx
`docs/**/*.md`: Review the documentation for clarity, grammar, and spelling. Make sure that the documentation is easy to understand and follow. There is currently a migration under...
docs/**/*.md: 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 indocsto 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.
docs/_docs/02_features/08-extra-arguments.mddocs/_docs/02_features/13-provider-cache-server.mddocs/_docs/02_features/14-engine.mddocs/_docs/02_features/15-cas.mddocs/_docs/02_features/09-aws-authentication.mddocs/_docs/02_features/10-hooks.mddocs/_docs/02_features/06-catalog.mddocs/_docs/02_features/12-runtime-control.mddocs/_docs/02_features/05-run-queue.mddocs/_docs/02_features/07-scaffold.md
🪛 LanguageTool
docs/_docs/02_features/05-run-queue.md
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...reference/cli-options#queue-include-dir): Specify glob patterns for directories t...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~45-~45: To form a complete sentence, be sure to include a subject.
Context: ... patterns for directories to include. Can be used multiple times. - [`--queue-exc...
(MISSING_IT_THERE)
[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...reference/cli-options#queue-exclude-dir): Specify glob patterns for directories t...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~46-~46: To form a complete sentence, be sure to include a subject.
Context: ... patterns for directories to exclude. Can be used multiple times. Note that depen...
(MISSING_IT_THERE)
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...ference/cli-options#queue-excludes-file): Provide a file containing a list of dir...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...erence/cli-options#queue-strict-include): Only include units matching `--queue-in...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...ence/cli-options#queue-include-external): Include external dependencies (those ou...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...ence/cli-options#queue-exclude-external): Exclude external dependencies. - [`--qu...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~51-~51: Loose punctuation mark.
Context: ...cli-options#queue-include-units-reading): Include units that read a specific file...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: A punctuation mark might be missing here.
Context: ...ons#run) using discovery commands, like find...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~55-~55: A punctuation mark might be missing here.
Context: ...](/docs/reference/cli-options#find) and list...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...ence/cli-options#queue-ignore-dag-order): Execute units concurrently without resp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~57-~57: Loose punctuation mark.
Context: ...ference/cli-options#queue-ignore-errors): Continue processing the queue even if s...
(UNLIKELY_OPENING_PUNCTUATION)
docs-starlight/src/content/docs/02-features/05-run-queue.mdx
[uncategorized] ~65-~65: Loose punctuation mark.
Context: ...ence/cli/commands/run#queue-include-dir): Specify glob patterns for directories t...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~65-~65: To form a complete sentence, be sure to include a subject.
Context: ... patterns for directories to include. Can be used multiple times. - [`--queue-e...
(MISSING_IT_THERE)
[uncategorized] ~66-~66: Loose punctuation mark.
Context: ...ence/cli/commands/run#queue-exclude-dir): Specify glob patterns for directories t...
(UNLIKELY_OPENING_PUNCTUATION)
[style] ~66-~66: To form a complete sentence, be sure to include a subject.
Context: ... patterns for directories to exclude. Can be used multiple times. Note that depen...
(MISSING_IT_THERE)
[uncategorized] ~67-~67: Loose punctuation mark.
Context: ...ce/cli/commands/run#queue-excludes-file): Provide a file containing a list of dir...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~68-~68: Loose punctuation mark.
Context: ...e/cli/commands/run#queue-strict-include): Only include units matching `--queue-in...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~69-~69: Loose punctuation mark.
Context: ...cli/commands/run#queue-include-external): Include external dependencies (those ou...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~70-~70: Loose punctuation mark.
Context: ...cli/commands/run#queue-exclude-external): Exclude external dependencies. - [`--...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~71-~71: Loose punctuation mark.
Context: ...ommands/run#queue-include-units-reading): Include units that read a specific file...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~75-~75: A punctuation mark might be missing here.
Context: ...nds/run) using discovery commands, like [find](/docs/reference/cli/commands/find...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~75-~75: A punctuation mark might be missing here.
Context: ...(/docs/reference/cli/commands/find) and [list](/docs/reference/cli/commands/list...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~76-~76: Loose punctuation mark.
Context: ...cli/commands/run#queue-ignore-dag-order): Execute units concurrently without resp...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ...ce/cli/commands/run#queue-ignore-errors): Continue processing the queue even if s...
(UNLIKELY_OPENING_PUNCTUATION)
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Test (macos)
- GitHub Check: Test (ubuntu)
- GitHub Check: build-and-test
- GitHub Check: Pull Request has non-contributor approval
🔇 Additional comments (34)
docs/_docs/02_features/14-engine.md (1)
8-8:❓ Verification inconclusive
Order metadata updated correctly
Updatedorderfrom213to214, maintaining the proper navigation sequence.
Please verify theorderin the Starlight documentation atdocs-starlight/src/content/docs/02-features/14-engine.md.
🏁 Script executed:
#!/bin/bash file="docs-starlight/src/content/docs/02-features/14-engine.md" if grep -q "^order: 214" "$file"; then echo "✔ Order in $file is correctly set to 214." else echo "✖ Order metadata mismatch in $file." exit 1 fiLength of output: 426
#!/bin/bash # Search for the '14-engine.md' file anywhere in the repository echo "🔍 Locating '14-engine.md'..." find . -type f -name '14-engine.md' # Search for the 'docs-starlight' directory echo "🔍 Locating 'docs-starlight' directory..." find . -type d -name 'docs-starlight'
#!/bin/bash # Locate the 'docs-starlight' directory echo "🔍 Locating 'docs-starlight' directory..." find . -type d -name 'docs-starlight' 2>/dev/null # Search for '14-engine.md' anywhere in the repo echo "🔍 Searching for '14-engine.md' file..." find . -type f -name '14-engine.md' 2>/dev/null # Search all Markdown files for 'order: 214' echo "🔍 Searching for 'order: 214' in .md files..." rg -n '^order: 214' -g '*.md' || true
🏁 Script executed:
#!/bin/bash # Locate any '14-engine.md' file in the repo echo "🔍 Finding '14-engine.md'..." find . -type f -name '14-engine.md' 2>/dev/null # Locate the 'docs-starlight' directory if it exists echo "🔍 Finding 'docs-starlight' directory..." find . -type d -name 'docs-starlight' 2>/dev/null # Search all Markdown files for 'order:' metadata echo "🔍 Scanning Markdown files for 'order:' entries..." rg -n '^order:' --glob '*.md' || trueLength of output: 2839
Order metadata correct in code; external docs verification needed
- Confirmed
order: 214indocs/_docs/02_features/14-engine.md(line 8).- Could not locate
docs-starlight/src/content/docs/02-features/14-engine.md; please manually verify that your Starlight documentation site has been updated to reflect this change.docs-starlight/src/content/docs/02-features/06-catalog.md (1)
6-6: Sidebar order updated correctly
Incremented from 5 to 6 to accommodate the new "Run Queue" page at order 5. Navigation flow remains consistent and clear.docs-starlight/src/content/docs/02-features/07-scaffold.md (1)
6-6: Sidebar order updated correctly
Incremented from 6 to 7 to reflect the insertion of the new "Run Queue" page. The sidebar sequence remains logical and user-friendly.docs-starlight/src/content/docs/02-features/09-authentication.md (1)
6-6: Sidebar order updated correctly
Incremented from 8 to 9 to follow the addition of "Run Queue" at order 5. Documentation order is maintained.docs-starlight/src/content/docs/02-features/14-engine.mdx (1)
6-6: Sidebar order updated correctly
Incremented from 13 to 14 to preserve proper ordering after adding the Run Queue documentation. Ordering is consistent across feature pages.docs-starlight/src/content/docs/02-features/11-auto-init.md (1)
6-6: Sidebar order updated correctly
Incremented from 10 to 11 to align with the updated sequence including the new "Run Queue" page. Sidebar navigation remains coherent.docs-starlight/src/content/docs/02-features/08-extra-arguments.mdx (1)
6-6: Sidebar order incremented
Theorderfrontmatter has been updated from 7 to 8 to maintain the correct sequence after adding the new "Run Queue" page. This mirrors the update indocs/_docs/02_features/08-extra-arguments.md.docs/_docs/02_features/09-aws-authentication.md (1)
8-8:❓ Verification inconclusive
Update sidebar order for AWS Authentication
The frontmatterorderhas been updated from 208 to 209. Please ensure the corresponding Starlight docs (docs-starlight/src/content/docs/02-features/09-authentication.mdx) reflect the same change.Run the following script to verify the
ordermetadata in the Starlight version:
🏁 Script executed:
#!/bin/bash # Locate the Starlight AWS Authentication page and check its order metadata file=$(rg -l 'title: AWS Authentication' -g 'docs-starlight/src/content/docs/02-features/*.mdx') echo "Checking order in $file:" rg -n '^order:' "$file"Length of output: 210
🏁 Script executed:
#!/bin/bash # 1. Find any MDX files mentioning "Authentication" in the Starlight docs echo "Searching for MDX files with 'Authentication' in docs-starlight:" rg -l 'Authentication' -g 'docs-starlight/src/content/docs/**/*.mdx' || echo "No matches found for 'Authentication'." # 2. List order metadata in all 02-features MDX files echo -e "\nOrder metadata in docs-starlight/src/content/docs/02-features:" find docs-starlight/src/content/docs/02-features -type f -name '*.mdx' -print0 \ | xargs -0 -I{} sh -c "printf '----- %s -----\n' {} && rg -n '^order:' {} || echo 'No order metadata found.'"Length of output: 1064
Update Starlight sidebar order for AWS Authentication
I wasn’t able to locate anorder:frontmatter entry indocs-starlight/src/content/docs/02-features/09-authentication.mdx(or any AWS Authentication MDX). Please verify the correct Starlight file path and update itsordermetadata from 208 → 209 to keep the sidebar in sync.docs/_docs/02_features/07-scaffold.md (1)
8-8:❓ Verification inconclusive
Update sidebar order for Scaffold
The frontmatterorderhas been updated from 206 to 207 to maintain sequential navigation after inserting "Run Queue". Confirm that the Starlight counterpart (docs-starlight/src/content/docs/02-features/07-scaffold.mdx) is updated accordingly.
🏁 Script executed:
#!/bin/bash # Verify the order metadata in the Starlight scaffold page file=$(rg -l 'title: Scaffold' -g 'docs-starlight/src/content/docs/02-features/*.mdx') echo "Checking order in $file:" rg -n '^order:' "$file"Length of output: 200
🏁 Script executed:
#!/bin/bash # List all MDX files in the Starlight features directory fd --extension mdx docs-starlight/src/content/docs/02-features # Locate the Scaffold page by title echo "Locating the Scaffold page:" file=$(rg -l 'title:\s*Scaffold' -g 'docs-starlight/src/content/docs/02-features/*.mdx') if [[ -z "$file" ]]; then echo "No Scaffold page found under docs-starlight/src/content/docs/02-features" exit 1 fi echo "Found Scaffold file: $file" # Verify the order frontmatter in that file echo "Order frontmatter in $file:" rg -n '^order:' "$file"Length of output: 877
#!/bin/bash set -e echo "1) Listing all MDX files in docs-starlight/src/content/docs/02-features/" find docs-starlight/src/content/docs/02-features -maxdepth 1 -type f -name "*.mdx" echo -e "\n2) Locating the Scaffold page by frontmatter title:" scaffold_file=$(grep -Rnl '^title:\s*Scaffold' docs-starlight/src/content/docs/02-features/*.mdx || true) if [[ -z "$scaffold_file" ]]; then echo "❌ No Scaffold page found under docs-starlight/src/content/docs/02-features" exit 1 fi echo "✅ Found: $scaffold_file" echo -e "\n3) Verifying 'order:' metadata in $scaffold_file" grep -n '^order:' "$scaffold_file" || echo "⚠️ No 'order:' frontmatter present"
🏁 Script executed:
#!/usr/bin/env bash set -euo pipefail echo "1) Locating any Scaffold MDX file under docs-starlight/src" scaffold_file=$(find docs-starlight/src -type f -iname "*scaffold*.mdx" | head -n1 || true) if [[ -z "$scaffold_file" ]]; then echo "❌ No Scaffold MDX file found in docs-starlight/src" exit 1 fi echo "✅ Found Scaffold file: $scaffold_file" echo -e "\n2) Showing frontmatter around 'order' in $scaffold_file" awk '/^---/{i++;next}i==1{print}/^order:/{print;exit}' "$scaffold_file" || echo "⚠️ 'order:' not present in frontmatter"Length of output: 1293
Verify Starlight Scaffold page order
I wasn’t able to locate a Starlight docs file atdocs-starlight/src/content/docs/02-features/07-scaffold.mdx. Please confirm that the “Scaffold” feature page exists there and that itsorderfrontmatter has been bumped from 206 to 207 to match the sidebar sequence.docs/_docs/02_features/08-extra-arguments.md (1)
8-8: Update sidebar order for Extra Arguments
Theordermetadata has been incremented from 207 to 208 to align with the feature sequence adjustments following the addition of the "Run Queue" page. This correctly mirrors the Starlight version.docs-starlight/src/content/docs/02-features/12-runtime-control.md (1)
6-6: Order metadata update is correct.The sidebar
order: 12aligns this page’s position correctly after the new Run Queue feature insertion and matches the sequence of adjacent feature docs.docs/_docs/02_features/06-catalog.md (1)
8-8: Ensure equivalent ordering update in docs-starlight.You updated the Jekyll front matter order to
206—please verify that the corresponding Starlight page underdocs-starlight/src/content/docs/02-features/06-catalog.mdhas also been updated toorder: 206to keep both documentation sources in sync.docs-starlight/src/content/docs/02-features/10-hooks.md (1)
6-6: Order metadata update is correct.The sidebar
order: 10has been incremented appropriately to reflect the new placement of the Hooks page in the feature list.docs-starlight/package.json (1)
17-17: Approve addition ofastro-d2dependency.Adding
"astro-d2": "^0.7.0"enables D2 diagram support as intended. Ensure the version aligns with the integration inastro.config.mjsand that development prerequisites are updated accordingly.docs-starlight/src/content/docs/02-features/13-provider-cache-server.md (1)
6-6: Order metadata update is correct.The sidebar
order: 13correctly reflects the repositioning of this page following the addition of the Run Queue and Runtime Control docs.docs-starlight/README.md (1)
19-20: Clear and accurate installation prerequisite added.The addition of the D2 installation instruction is clear and necessary for developers who need to work with diagrams in the documentation. The provided link to the installation guide is helpful.
docs-starlight/vercel.json (1)
1-4: Well-structured Vercel configuration.The configuration properly sets up the build environment with both the project dependencies and the D2 diagramming tool needed for documentation diagrams. This ensures consistent builds in the Vercel environment.
docs-starlight/astro.config.mjs (4)
2-7: Consistent import style applied.The imports have been updated to consistently use double quotes, improving code style consistency.
7-7: D2 integration successfully added.The import of the D2 integration aligns with the addition of diagram support for documentation.
104-105: Properly excluded CLI command URLs from link validation.The additions to the exclude list for link validation are appropriate for list command URLs, which are generated content that can't be validated during build time.
110-110: D2 integration correctly added to the configuration.The D2 integration has been properly added to the integrations array, enabling diagram rendering capabilities.
docs/_docs/02_features/05-run-queue.md (7)
1-12: Well-structured frontmatter with appropriate metadata.The frontmatter contains all necessary metadata for the documentation page, including title, category, and ordering information.
14-15: Clear introduction to the Run Queue concept.The introduction effectively explains what the Run Queue is and how it relates to Terragrunt's features, with appropriate links to related documentation.
16-27: Well-explained DAG concept and execution order.This section clearly explains how Terragrunt uses a directed acyclic graph to manage dependencies and execution order, with a good breakdown of the discovery, queue construction, and execution process.
28-36: Excellent example with visual representation.The example DAG with its explanation of different execution orders for plan and destroy commands provides valuable context for users to understand the queue behavior.
54-58: Clear explanation of order modification options.The explanation of options for modifying queue order and error handling is concise and includes important warnings about potential risks.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~55-~55: A punctuation mark might be missing here.
Context: ...ons#run) using discovery commands, likefind...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~55-~55: A punctuation mark might be missing here.
Context: ...](/docs/reference/cli-options#find) andlist...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...ence/cli-options#queue-ignore-dag-order): Execute units concurrently without resp...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~57-~57: Loose punctuation mark.
Context: ...ference/cli-options#queue-ignore-errors): Continue processing the queue even if s...(UNLIKELY_OPENING_PUNCTUATION)
59-69: Important considerations section highlights crucial caveats.This section effectively highlights important considerations and potential issues users might encounter, along with workarounds and best practices.
1-70:✅ Verification successful
Ensure documentation exists in both locations.
The PR objectives mention documenting the Run Queue feature, and this file provides excellent documentation in the Jekyll-based docs. Confirm that an equivalent file exists in the Starlight-based docs (
docs-starlight/src/content/docs/02-features/05-run-queue.mdx) to keep both documentation sets synchronized.
🏁 Script executed:
#!/bin/bash # Check if the equivalent Starlight documentation file exists if [ -f "docs-starlight/src/content/docs/02-features/05-run-queue.mdx" ]; then echo "✅ Equivalent documentation file exists in Starlight docs" else echo "❌ Missing equivalent documentation file in Starlight docs" fiLength of output: 196
Documentation in Starlight Verified
The filedocs-starlight/src/content/docs/02-features/05-run-queue.mdxexists, matching the Jekyll docs atdocs/_docs/02_features/05-run-queue.md. No further action required.🧰 Tools
🪛 LanguageTool
[uncategorized] ~45-~45: Loose punctuation mark.
Context: ...reference/cli-options#queue-include-dir): Specify glob patterns for directories t...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~45-~45: To form a complete sentence, be sure to include a subject.
Context: ... patterns for directories to include. Can be used multiple times. - [`--queue-exc...(MISSING_IT_THERE)
[uncategorized] ~46-~46: Loose punctuation mark.
Context: ...reference/cli-options#queue-exclude-dir): Specify glob patterns for directories t...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~46-~46: To form a complete sentence, be sure to include a subject.
Context: ... patterns for directories to exclude. Can be used multiple times. Note that depen...(MISSING_IT_THERE)
[uncategorized] ~47-~47: Loose punctuation mark.
Context: ...ference/cli-options#queue-excludes-file): Provide a file containing a list of dir...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~48-~48: Loose punctuation mark.
Context: ...erence/cli-options#queue-strict-include): Only include units matching `--queue-in...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~49-~49: Loose punctuation mark.
Context: ...ence/cli-options#queue-include-external): Include external dependencies (those ou...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~50-~50: Loose punctuation mark.
Context: ...ence/cli-options#queue-exclude-external): Exclude external dependencies. - [`--qu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~51-~51: Loose punctuation mark.
Context: ...cli-options#queue-include-units-reading): Include units that read a specific file...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~55-~55: A punctuation mark might be missing here.
Context: ...ons#run) using discovery commands, likefind...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~55-~55: A punctuation mark might be missing here.
Context: ...](/docs/reference/cli-options#find) andlist...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~56-~56: Loose punctuation mark.
Context: ...ence/cli-options#queue-ignore-dag-order): Execute units concurrently without resp...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~57-~57: Loose punctuation mark.
Context: ...ference/cli-options#queue-ignore-errors): Continue processing the queue even if s...(UNLIKELY_OPENING_PUNCTUATION)
docs-starlight/src/content/docs/02-features/05-run-queue.mdx (6)
1-7: Frontmatter validation – looks good
The title, description, slug, and sidebar order are all present and correctly formatted according to the project conventions.
9-9: Confirm import of Aside component
The<Aside>component is correctly imported from@astrojs/starlight/componentsand used below for cautions. No issues detected.
11-12: Introductory paragraph is clear
The description succinctly explains the purpose of the Run Queue feature and links to the Units page. Nicely done.
25-53: Example DAG diagram snippet – approved
The D2 diagram clearly defines nodes and connections for Units A–D. It aligns with the description that follows.
73-78: Verify reference link and improve phrasing
- The link for
--queue-construct-aspoints to/docs/reference/cli/commands/list#queue-construct-as, but this flag is part of theruncommand. Please confirm the correct anchor (likely underrun).- Also consider rephrasing the bullet to start with an active verb:
- [`--queue-construct-as`](/docs/reference/cli/commands/run#queue-construct-as) (`--as`): Build the dependency queue *as if* running a particular command. Useful for dry-runs of `run` via discovery commands like `find` and `list`.🧰 Tools
🪛 LanguageTool
[uncategorized] ~75-~75: A punctuation mark might be missing here.
Context: ...nds/run) using discovery commands, like [find](/docs/reference/cli/commands/find...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~75-~75: A punctuation mark might be missing here.
Context: ...(/docs/reference/cli/commands/find) and [list](/docs/reference/cli/commands/list...(AI_EN_LECTOR_MISSING_PUNCTUATION)
[uncategorized] ~76-~76: Loose punctuation mark.
Context: ...cli/commands/run#queue-ignore-dag-order): Execute units concurrently without resp...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~77-~77: Loose punctuation mark.
Context: ...ce/cli/commands/run#queue-ignore-errors): Continue processing the queue even if s...(UNLIKELY_OPENING_PUNCTUATION)
81-95: Aside blocks – approved
The three cautionary asides are clear, well-formatted, and appropriately highlight operational caveats. No changes needed.
| @@ -5,7 +5,7 @@ category: features | |||
| categories_url: features | |||
| excerpt: Learn how Terragrunt supports deduplication of content using a Content Addressable Store (CAS). | |||
| tags: ["cas"] | |||
| order: 214 | |||
| order: 215 | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Order metadata updated correctly
The order front matter has been updated from 214 to 215, which aligns with the sequential ordering of the feature documentation.
Ensure that the corresponding Starlight + Astro version under docs-starlight/src/content/docs/02-features/15-cas.md has been updated with the same order: 215.
🏁 Script executed:
#!/bin/bash
file="docs-starlight/src/content/docs/02-features/15-cas.md"
if grep -q "^order: 215" "$file"; then
echo "✔ Order in $file is correctly set to 215."
else
echo "✖ Order metadata mismatch in $file."
exit 1
fiLength of output: 324
Update order metadata in Starlight docs
The corresponding Starlight feature file is still using the old order value. Please update the front matter in docs-starlight/src/content/docs/02-features/15-cas.md to match:
- order: 214
+ order: 215📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| order: 215 | |
| order: 215 |
| @@ -5,7 +5,7 @@ category: features | |||
| categories_url: features | |||
| excerpt: Learn how Terragrunt allows for runtime control using feature flags, error handling, and excludes. | |||
| tags: ["CLI"] | |||
| order: 211 | |||
| order: 212 | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Order metadata updated correctly
The front matter order value has been incremented to 212 for consistent sidebar ordering.
Confirm that docs-starlight/src/content/docs/02-features/12-runtime-control.md reflects the same change.
🏁 Script executed:
#!/bin/bash
file="docs-starlight/src/content/docs/02-features/12-runtime-control.md"
if grep -q "^order: 212" "$file"; then
echo "✔ Order in $file is correctly set to 212."
else
echo "✖ Order metadata mismatch in $file."
exit 1
fiLength of output: 372
🏁 Script executed:
#!/bin/bash
file="docs-starlight/src/content/docs/02-features/12-runtime-control.md"
echo "Searching for existing order metadata in $file:"
grep -n '^order:' "$file" || echo "⚠ No order metadata found."
echo
echo "Front matter preview (lines 1–20):"
sed -n '1,20p' "$file"Length of output: 1356
Update sidebar.order in docs-starlight to match new ordering
The front matter in docs-starlight/src/content/docs/02-features/12-runtime-control.md still has:
sidebar:
order: 12It needs to be updated to 212 to stay in sync with the primary docs.
Suggested change:
--- a/docs-starlight/src/content/docs/02-features/12-runtime-control.md
+++ b/docs-starlight/src/content/docs/02-features/12-runtime-control.md
@@
-sidebar:
- order: 12
+sidebar:
+ order: 212| @@ -5,7 +5,7 @@ category: features | |||
| categories_url: features | |||
| excerpt: Learn how to use the Terragrunt provider cache server. | |||
| tags: ["cache", "provider"] | |||
| order: 212 | |||
| order: 213 | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Order metadata updated correctly
Updated order to 213 to reflect the new feature sequence.
Make sure the Starlight version at docs-starlight/src/content/docs/02-features/13-provider-cache-server.md is also updated accordingly.
🏁 Script executed:
#!/bin/bash
file="docs-starlight/src/content/docs/02-features/13-provider-cache-server.md"
if grep -q "^order: 213" "$file"; then
echo "✔ Order in $file is correctly set to 213."
else
echo "✖ Order metadata mismatch in $file."
exit 1
fiLength of output: 396
I wasn’t able to confirm the current order: value in the Starlight file. Let’s dump its metadata to check:
🏁 Script executed:
#!/bin/bash
file="docs-starlight/src/content/docs/02-features/13-provider-cache-server.md"
echo "---- Top of file ($file) ----"
head -n 20 "$file"
echo -e "\n---- Lines containing 'order:' ----"
grep -n '^order:' "$file" || echo "No 'order:' line found."Length of output: 2813
Update Starlight metadata order to 213
The Starlight file still has sidebar.order: 13; it needs to match the main docs’ order: 213.
• docs-starlight/src/content/docs/02-features/13-provider-cache-server.md
--- a/docs-starlight/src/content/docs/02-features/13-provider-cache-server.md
+++ b/docs-starlight/src/content/docs/02-features/13-provider-cache-server.md
@@
-sidebar:
- order: 13
+sidebar:
+ order: 213Please apply this change so the feature sequence is consistent across both documentation sources.
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| order: 213 | |
| sidebar: | |
| order: 213 |
| @@ -5,7 +5,7 @@ category: features | |||
| categories_url: features | |||
| excerpt: Learn how to execute custom code before or after running OpenTofu/Terraform, or when errors occur. | |||
| tags: ["hooks"] | |||
| order: 209 | |||
| order: 211 | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Order metadata updated correctly
The order value has been updated to 211, aligning with the adjacent feature docs.
Verify that the corresponding file in docs-starlight/src/content/docs/02-features/10-hooks.md has the same order: 211.
🏁 Script executed:
#!/bin/bash
file="docs-starlight/src/content/docs/02-features/10-hooks.md"
if grep -q "^order: 211" "$file"; then
echo "✔ Order in $file is correctly set to 211."
else
echo "✖ Order metadata mismatch in $file."
exit 1
fiLength of output: 332
Order metadata mismatch in the Starlight docs
The order in docs/_docs/02_features/10-hooks.md was updated to 211, but the mirrored file in the Starlight site still has a different value. Please update its frontmatter to keep both sets of docs in sync.
• File to fix:
- docs-starlight/src/content/docs/02-features/10-hooks.md
Suggested change (in the YAML frontmatter):
- order: <current_value>
+ order: 211📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| order: 211 | |
| - order: <current_value> | |
| + order: 211 |
| @@ -3,7 +3,7 @@ title: Content Addressable Store (CAS) | |||
| description: Learn how Terragrunt supports deduplication of content using a Content Addressable Store (CAS). | |||
| slug: docs/features/cas | |||
| sidebar: | |||
| order: 14 | |||
| order: 15 | |||
There was a problem hiding this comment.
💡 Verification agent
🧩 Analysis chain
Update sidebar order for CAS page
The order frontmatter has been updated from 14 to 15 to reflect the insertion of the new "Run Queue" documentation. Please verify that the Jekyll docs at docs/_docs/02_features/15-cas.md have the same update.
🏁 Script executed:
#!/bin/bash
# Verify order metadata in the Jekyll CAS page
file="docs/_docs/02_features/15-cas.md"
rg -n '^order:' "$file"Length of output: 103
Fix incorrect sidebar order in Jekyll CAS page
The order frontmatter in docs/_docs/02_features/15-cas.md is set to 215 instead of 15, so it won’t reflect the newly inserted “Run Queue” doc correctly.
Please update it as follows:
• File: docs/_docs/02_features/15-cas.md, line 8
- order: 215
+ order: 15Committable suggestion skipped: line range outside the PR's diff.
| - **`run --all plan` Order:** Terragrunt would run C and D concurrently. Once C finishes, B would run. Once B finishes, A would run. | ||
| - **`run --all destroy` Order:** Terragrunt would run A and D concurrently. Once A finishes, B would run. Once B finishes, C would run. | ||
|
|
There was a problem hiding this comment.
Critical: Plan/Destroy execution order descriptions are swapped
The text under “run --all plan” describes destroy behavior, and vice versa. This will confuse users. Please apply this fix:
- **`run --all plan` Order:** Terragrunt would run C and D concurrently. Once C finishes, B would run. Once B finishes, A would run.
- **`run --all destroy` Order:** Terragrunt would run A and D concurrently. Once A finishes, B would run. Once B finishes, C would run.
+ **`run --all plan` Order:** Terragrunt would run **A** and **D** concurrently. Once **A** finishes, **B** runs. Once **B** finishes, **C** runs.
+ **`run --all destroy` Order:** Terragrunt would run **C** and **D** concurrently. Once **C** finishes, **B** runs. Once **B** finishes, **A** runs.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - **`run --all plan` Order:** Terragrunt would run C and D concurrently. Once C finishes, B would run. Once B finishes, A would run. | |
| - **`run --all destroy` Order:** Terragrunt would run A and D concurrently. Once A finishes, B would run. Once B finishes, C would run. | |
| - **`run --all plan` Order:** Terragrunt would run **A** and **D** concurrently. Once **A** finishes, **B** runs. Once **B** finishes, **C** runs. | |
| - **`run --all destroy` Order:** Terragrunt would run **C** and **D** concurrently. Once **C** finishes, **B** runs. Once **B** finishes, **A** runs. |
Description
Fixes #4248.
TODOs
Read the Gruntwork contribution guidelines.
Release Notes (draft)
Added
Run Queuefeature docs.Summary by CodeRabbit