-
Notifications
You must be signed in to change notification settings - Fork 43
feat: change types docs #2663
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: change types docs #2663
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughA new documentation file detailing the pull request change detection system for Terragrunt infrastructure management was added, and the sidebar configuration was updated to include this documentation under the "Architecture" section of Pipelines. No changes were made to existing code or sidebar structure beyond these additions. Changes
Poem
🪧 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
CodeRabbit Configuration File (
|
|
||
#### `ModulesAddedOrChanged` | ||
**Trigger**: Aggregated change type for multiple module modifications | ||
- **Behavior**: Handles scenarios with multiple module changes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Needs more detail
There was a problem hiding this 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
🧹 Nitpick comments (2)
docs/2.0/docs/pipelines/architecture/change-types.md (2)
3-8
: Consider GitHub vs GitLab wording per docs style guideThroughout the doc we exclusively say “pull request(s)”. Because the Pipelines product supports both SCMs, the style guide (see retrieved learning) asks us to use either:
• “pull/merge request(s)” when the difference is a single word, or
•<Tabs><TabItem>
blocks when the workflows differ.Here the workflows are identical, so a simple wording tweak is enough:
-specified in a pull request. +specified in a pull/merge request.
118-123
: Link the feature flag to configuration docs for discoverabilityMentioning the
moduleChangeOnUnitFile
flag without a pointer leaves readers hunting. Add an inline link to the flag definition (assuming it exists underguides/file-dependencies
).-The system supports a feature flag `moduleChangeOnUnitFile` that enables detecting module changes ... +The system supports a feature flag [`moduleChangeOnUnitFile`](../guides/file-dependencies#modulechangeonunitfile) +that enables detecting module changes ...
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/2.0/docs/pipelines/architecture/change-types.md
(1 hunks)sidebars/docs.js
(1 hunks)
🧰 Additional context used
🧠 Learnings (3)
📓 Common learnings
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
sidebars/docs.js (1)
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
docs/2.0/docs/pipelines/architecture/change-types.md (1)
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
⏰ 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). (3)
- GitHub Check: Pull Request has non-contributor approval
- GitHub Check: Validate generated content
- GitHub Check: validate_build
🔇 Additional comments (2)
docs/2.0/docs/pipelines/architecture/change-types.md (1)
246-255
: Clarify whetherrun-all
is used for multi-module plansFor module additions/changes we show:
terragrunt plan terragrunt applyIf Pipelines actually runs
terragrunt run-all plan
/run-all apply
at the repo root (common pattern), call that out explicitly to avoid user confusion.sidebars/docs.js (1)
159-163
: Sidebar ID path confirmed; no issuesThe new “Pull Request Behaviors” entry references
2.0/docs/pipelines/architecture/change-types
, which matches the added markdown file. Placement under Architecture feels logical and alphabetical order wasn’t strictly followed before, so this insert looks good.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/2.0/docs/pipelines/architecture/change-types.md (2)
1-7
: Front-matter looks good, but you may want SEO niceties
Consider addingkeywords
(and, if your theme supports it,image
) to help search-ranking and social previews.
9-15
: Terminology is GitHub-only – reflect GitLab users per house style
Per the learning on PR / MR wording, anywhere we say “pull request” we should either say “pull/merge request” or wrap the divergent sections in<Tabs>
/<TabItem>
.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2.0/docs/pipelines/architecture/change-types.md
(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
docs/2.0/docs/pipelines/architecture/change-types.md (1)
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
⏰ 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: Pull Request has non-contributor approval
- GitHub Check: Validate generated content
🔇 Additional comments (2)
docs/2.0/docs/pipelines/architecture/change-types.md (2)
44-48
:ModuleDriftedAndChanged
section lacks concrete command list
Every other change type documents the exact Terragrunt commands for PR vs merge. Documenting them here will spare users guess-work.
70-72
: Flag names: double-check consistency with actual CLI
--queue-include-dir
appears here; elsewhere we use--queue-include-dir=<directory>
(good). Verify the exact flag spelling matches the implementation to avoid copy-paste errors in run-books.
There was a problem hiding this 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
🧹 Nitpick comments (2)
docs/2.0/docs/pipelines/architecture/change-types.md (2)
8-14
: Broaden wording for GitHub / GitLab parityThe doc exclusively references “pull requests”. Per team guideline (see
.cursor/rules/gitlab-background.mdc
), either replace with the neutral “pull/merge requests” or add a<Tabs>
block differentiating GitHub vs GitLab where behaviour differs.
3-9
: Minor consistency nit – match punctuation in title and H1Front-matter uses an en-dash “Pull Request Behaviors – Change Types” while the H1 uses a hyphen “Pull Request Behaviors - Change Types”. Pick one style to avoid subtle duplication in search results.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2.0/docs/pipelines/architecture/change-types.md
(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
docs/2.0/docs/pipelines/architecture/change-types.md (1)
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
⏰ 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: Pull Request has non-contributor approval
- GitHub Check: Validate generated content
🔇 Additional comments (1)
docs/2.0/docs/pipelines/architecture/change-types.md (1)
1-6
: Front-matter metadata looks greatThe required Docusaurus front-matter is now present and complete (id, title, slug via
id
, sidebar label, description). This will index the page correctly and avoid the default H1 fallback.
There was a problem hiding this 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)
docs/2.0/docs/pipelines/architecture/change-types.md (1)
59-61
:terragrunt run --all …
is still incorrect – userun-all
This was already flagged in a previous review. Terragrunt’s sub-command is
run-all
, notrun --all
; the current form will error out withunknown flag: --all
.Please replace every occurrence.
Also applies to: 69-70, 117-119, 291-296, 301-306, 311-316, 328-333, 355-366
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2.0/docs/pipelines/architecture/change-types.md
(1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
docs/2.0/docs/pipelines/architecture/change-types.md (1)
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
⏰ 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). (3)
- GitHub Check: Pull Request has non-contributor approval
- GitHub Check: validate_build
- GitHub Check: Validate generated content
Co-authored-by: Oreoluwa Agunbiade <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (4)
docs/2.0/docs/pipelines/architecture/change-types.md (4)
45-46
: Strip trailing spaces inside inline code to satisfymarkdownlint
(MD038)The extra blanks render literally in HTML and trip the linter.
- - **PR**: `terragrunt plan -destroy ` + - **PR**: `terragrunt plan -destroy` - - **Merge**: `terragrunt destroy ` + - **Merge**: `terragrunt destroy` @@ - - **Example**: `terragrunt plan ` + - **Example**: `terragrunt plan`Also applies to: 332-332
65-66
: Remove the double-space between the sub-command and the first flagOne space is enough; it keeps the examples copy-paste-friendly and silences MD038 in a few other spots.
- - **PR**: `terragrunt run --all plan --units-that-include=<changed_file>` + - **PR**: `terragrunt run --all plan --units-that-include=<changed_file>` - - **Merge**: `terragrunt run --all apply --units-that-include=<changed_file>` + - **Merge**: `terragrunt run --all apply --units-that-include=<changed_file>`Do the same pattern for the
--queue-include-*
and--queue-include-units-reading
examples further down.Also applies to: 75-76, 123-124, 288-292, 298-302, 308-312
77-77
: Minor typos – “propagate” and “use case”-…settings and want to propegate those changes… +…settings and want to propagate those changes… @@ -…This should be a very rare usecase where… +…This should be a very rare use case where…Also applies to: 99-99
1-6
: Consider adding an explicitslug
for stable URLsMost docs in this repo pin the path with a
slug
field; adding it avoids surprises if the folder layout changes.description: How the Pipelines change-detection engine maps repo changes to Terragrunt commands. +slug: /pipelines/architecture/change-types ---
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2.0/docs/pipelines/architecture/change-types.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:1-6
Timestamp: 2025-07-17T18:43:26.978Z
Learning: In the gruntwork-io/docs repository, document IDs should match the filename (without extension) rather than being namespaced. For example, a file named "change-types.md" should have `id: change-types` in the front matter.
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
docs/2.0/docs/pipelines/architecture/change-types.md (3)
Learnt from: ZachGoldberg
PR: gruntwork-io/docs#2663
File: docs/2.0/docs/pipelines/architecture/change-types.md:1-6
Timestamp: 2025-07-17T18:43:26.978Z
Learning: In the gruntwork-io/docs repository, document IDs should match the filename (without extension) rather than being namespaced. For example, a file named "change-types.md" should have `id: change-types` in the front matter.
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.128Z
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.
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
🪛 markdownlint-cli2 (0.17.2)
docs/2.0/docs/pipelines/architecture/change-types.md
45-45: Spaces inside code span elements
(MD038, no-space-in-code)
46-46: Spaces inside code span elements
(MD038, no-space-in-code)
332-332: Spaces inside code span elements
(MD038, no-space-in-code)
⏰ 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). (3)
- GitHub Check: validate_build
- GitHub Check: Pull Request has non-contributor approval
- GitHub Check: Validate generated content
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/2.0/docs/pipelines/architecture/change-types.md (2)
44-46
: Strip leading/trailing spaces inside inline code spansMarkdown-lint (
MD038
) flags the two back-ticked commands for having a space before the closing back-tick. Removing the extra space keeps the doc lint-clean and avoids accidental copy-paste errors.- - **PR**: `terragrunt plan -destroy ` + - **PR**: `terragrunt plan -destroy` - - **Merge**: `terragrunt destroy ` + - **Merge**: `terragrunt destroy`
330-333
: Same trailing-space issue in the example blockOne more MD038 hit—drop the trailing space.
- - **Example**: `terragrunt plan ` + - **Example**: `terragrunt plan`
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2.0/docs/pipelines/architecture/change-types.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:1-6
Timestamp: 2025-07-17T18:43:26.978Z
Learning: In the gruntwork-io/docs repository, document IDs should match the filename (without extension) rather than being namespaced. For example, a file named "change-types.md" should have `id: change-types` in the front matter.
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
docs/2.0/docs/pipelines/architecture/change-types.md (3)
Learnt from: ZachGoldberg
PR: gruntwork-io/docs#2663
File: docs/2.0/docs/pipelines/architecture/change-types.md:1-6
Timestamp: 2025-07-17T18:43:26.978Z
Learning: In the gruntwork-io/docs repository, document IDs should match the filename (without extension) rather than being namespaced. For example, a file named "change-types.md" should have `id: change-types` in the front matter.
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.128Z
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.
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
🪛 markdownlint-cli2 (0.17.2)
docs/2.0/docs/pipelines/architecture/change-types.md
45-45: Spaces inside code span elements
(MD038, no-space-in-code)
46-46: Spaces inside code span elements
(MD038, no-space-in-code)
332-332: Spaces inside code span elements
(MD038, no-space-in-code)
⏰ 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). (3)
- GitHub Check: Validate generated content
- GitHub Check: Pull Request has non-contributor approval
- GitHub Check: validate_build
🔇 Additional comments (1)
docs/2.0/docs/pipelines/architecture/change-types.md (1)
1-6
: Front-matter looks goodThe mandatory YAML block is present and follows the repository convention (
id
matches the filename).
There was a problem hiding this 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
🧹 Nitpick comments (1)
docs/2.0/docs/pipelines/architecture/change-types.md (1)
1-6
: Add an explicitslug
for stable URLs (optional)Most docs in this repo include a
slug
in the front-matter to guarantee permalink stability even if file locations change. Consider:--- id: change-types title: Pull Request Behaviors – Change Types sidebar_label: Pull Request Behaviors description: How the Pipelines change-detection engine maps repo changes to Terragrunt commands. +slug: /pipelines/architecture/change-types ---
This is purely for UX / SEO; feel free to skip if your site generator already derives the slug automatically.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2.0/docs/pipelines/architecture/change-types.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:1-6
Timestamp: 2025-07-17T18:43:26.978Z
Learning: In the gruntwork-io/docs repository, document IDs should match the filename (without extension) rather than being namespaced. For example, a file named "change-types.md" should have `id: change-types` in the front matter.
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
docs/2.0/docs/pipelines/architecture/change-types.md (3)
Learnt from: ZachGoldberg
PR: gruntwork-io/docs#2663
File: docs/2.0/docs/pipelines/architecture/change-types.md:1-6
Timestamp: 2025-07-17T18:43:26.978Z
Learning: In the gruntwork-io/docs repository, document IDs should match the filename (without extension) rather than being namespaced. For example, a file named "change-types.md" should have `id: change-types` in the front matter.
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.128Z
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.
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
⏰ 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). (3)
- GitHub Check: Pull Request has non-contributor approval
- GitHub Check: validate_build
- GitHub Check: Validate generated content
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/2.0/docs/pipelines/architecture/change-types.md (1)
1-6
: Add an explicitslug
to lock the URL pathDocusaurus will infer a slug from the
id
, but setting it explicitly prevents future breakage if the file is reorganised or renamed.--- id: change-types title: Pull Request Behaviors – Change Types sidebar_label: Pull Request Behaviors description: How the Pipelines change-detection engine maps repo changes to Terragrunt commands. +slug: /pipelines/architecture/change-types ---
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/2.0/docs/pipelines/architecture/change-types.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:1-6
Timestamp: 2025-07-17T18:43:26.978Z
Learning: In the gruntwork-io/docs repository, document IDs should match the filename (without extension) rather than being namespaced. For example, a file named "change-types.md" should have `id: change-types` in the front matter.
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
docs/2.0/docs/pipelines/architecture/change-types.md (3)
Learnt from: ZachGoldberg
PR: gruntwork-io/docs#2663
File: docs/2.0/docs/pipelines/architecture/change-types.md:1-6
Timestamp: 2025-07-17T18:43:26.978Z
Learning: In the gruntwork-io/docs repository, document IDs should match the filename (without extension) rather than being namespaced. For example, a file named "change-types.md" should have `id: change-types` in the front matter.
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.128Z
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.
Learnt from: CR
PR: gruntwork-io/docs#0
File: .cursor/rules/gitlab-background.mdc:0-0
Timestamp: 2025-07-08T23:10:15.896Z
Learning: Whenever presenting information that diverges between GitHub and GitLab, use the <Tabs> and <TabItem> components to distinguish the two sets of information UNLESS the distinction is just changing one word. For example, GitHub has pull requests and GitLab has merge requests, so we can just say '... pull/merge requests...' and not need full <Tabs>.
⏰ 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). (3)
- GitHub Check: Pull Request has non-contributor approval
- GitHub Check: validate_build
- GitHub Check: Validate generated content
🔇 Additional comments (1)
docs/2.0/docs/pipelines/architecture/change-types.md (1)
59-67
: Flag order now correct – looks goodThe
--units-that-include
flag is placed before the Terraform sub-command (plan
/apply
), which is required for Terragrunt to parse it properly. Nice fix.
Content is AI-originated and manually curated.
Summary by CodeRabbit
Summary by CodeRabbit