DEV-1338 Add Updating Terragrunt Scale Plan and Apply Roles#3057
Open
Resonance1584 wants to merge 3 commits intomainfrom
Open
DEV-1338 Add Updating Terragrunt Scale Plan and Apply Roles#3057Resonance1584 wants to merge 3 commits intomainfrom
Resonance1584 wants to merge 3 commits intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
WalkthroughAdded a new guide for updating Terragrunt Scale Plan and Apply roles (AWS/Azure), quoted generated paths in a deployment tutorial's shell commands, registered the guide in the docs sidebar, and marked Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
docs/2.0/docs/pipelines/guides/updating-plan-apply-roles.md (1)
25-27: Consider adding language specifiers to code blocks.The code blocks showing directory paths don't have language specifiers. While they render correctly, adding
textor another appropriate identifier improves consistency and helps documentation linters.Example for line 25-27:
-``` +```text $$ACCOUNT_NAME$$/_global/bootstrap/terragrunt.stack.hclApply similar changes to the other path examples at lines 49, 80, and 104. Also applies to: 49-51, 80-82, 104-106 <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@docs/2.0/docs/pipelines/guides/updating-plan-apply-roles.mdaround lines 25
- 27, The documentation contains several fenced code blocks that show directory
paths (e.g., the block with
$$ACCOUNT_NAME$$ /_global/bootstrap/terragrunt.stack.hcl and the other path
examples referenced at the same sections) but lack language specifiers; update
each of those code fences (the examples around the occurrences noted) to use a
plain text specifier by changingtotext so linters and renderers
consistently treat them as text (apply this to the blocks at the three
additional occurrences mentioned as well).</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In@docs/2.0/docs/pipelines/guides/updating-plan-apply-roles.md:
- Around line 25-27: The documentation contains several fenced code blocks that
show directory paths (e.g., the block with
$$ACCOUNT_NAME$$ /_global/bootstrap/terragrunt.stack.hcl and the other path
examples referenced at the same sections) but lack language specifiers; update
each of those code fences (the examples around the occurrences noted) to use a
plain text specifier by changingtotext so linters and renderers
consistently treat them as text (apply this to the blocks at the three
additional occurrences mentioned as well).</details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: Repository UI **Review profile**: CHILL **Plan**: Pro **Run ID**: `aecad60e-5a80-411e-a2db-cb1a76e8137f` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between 1fe5f4ddb239aaef9a69229c7c5db8ad03f150e8 and 238e058d0386a3a530757adaecfa50b8ee048717. </details> <details> <summary>⛔ Files ignored due to path filters (1)</summary> * `static/img/pipelines/guides/aws-iam-roles.png` is excluded by `!**/*.png` </details> <details> <summary>📒 Files selected for processing (4)</summary> * `docs/2.0/docs/pipelines/guides/updating-plan-apply-roles.md` * `docs/2.0/docs/pipelines/tutorials/deploying-your-first-infrastructure-change.mdx` * `sidebars/docs.js` * `src/theme/Root.js` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
Contributor
|
Will give this a complete read later today. A few quick impressions:
|
Contributor
Author
@ebeneliason they switch the urls for the links to the stack |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/2.0/docs/pipelines/guides/updating-plan-apply-roles.md`:
- Around line 29-31: The markdown code fences showing paths like
"$$ACCOUNT_NAME$$/_global/bootstrap/terragrunt.stack.hcl" and
"$$SUBSCRIPTION_NAME$$/bootstrap/terragrunt.stack.hcl" are missing language
identifiers and trigger MD040; update each of those fenced blocks (the four
occurrences at ~29-31 and the other occurrences at 53-55, 84-86, 108-110) by
changing the opening fence from ``` to ```text so the path-only blocks are
explicitly tagged as text.
- Line 308: The duplicate numbered section headings like "### 1. Copy the
default policy files" inside the tabbed variants trigger MD024; fix by either
restructuring the tab content so each tab uses unique subheadings (e.g.,
"GitHub: Copy the default policy files" / "GitLab: Copy the default policy
files") or locally suppress MD024 around the entire tabbed block (wrap the tab
block with markdownlint disable/enable for MD024) so the parallel tab headings
are allowed; apply the same change for the other repeated headings in this file
(the other tabbed "### 1/2/3/4..." blocks referenced in the review).
- Around line 162-179: Update the fenced code blocks that contain commented JSON
examples to use jsonc instead of json so readers know comments are allowed;
specifically change the code fence languages for the snippets titled
"$$ACCOUNT_NAME$$/_global/bootstrap/custom_plan_iam_policy.json" and
"$$ACCOUNT_NAME$$/_global/bootstrap/custom_apply_iam_policy.json" (and the other
occurrences called out in the review at the later ranges) from ```json to
```jsonc so the inline comments like "// ... existing statements ..." are valid
and the examples are not mistaken for strict JSON.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: b5a60a9e-ff3e-4f84-a42d-e902d7c95c7e
📒 Files selected for processing (2)
docs/2.0/docs/pipelines/guides/updating-plan-apply-roles.mdsidebars/docs.js
Comment on lines
+29
to
+31
| ``` | ||
| $$ACCOUNT_NAME$$/_global/bootstrap/terragrunt.stack.hcl | ||
| ``` |
Contributor
There was a problem hiding this comment.
Add explicit language identifiers to the path-only code fences.
These four fenced blocks are missing language tags and trigger MD040 warnings.
Suggested patch
-```
+```text
$$ACCOUNT_NAME$$/_global/bootstrap/terragrunt.stack.hcl@@
- +text
@@
-```
+```text
$$ACCOUNT_NAME$$/_global/bootstrap/terragrunt.stack.hcl
@@
- +text
Also applies to: 53-55, 84-86, 108-110
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 29-29: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2.0/docs/pipelines/guides/updating-plan-apply-roles.md` around lines 29
- 31, The markdown code fences showing paths like
"$$ACCOUNT_NAME$$/_global/bootstrap/terragrunt.stack.hcl" and
"$$SUBSCRIPTION_NAME$$/bootstrap/terragrunt.stack.hcl" are missing language
identifiers and trigger MD040; update each of those fenced blocks (the four
occurrences at ~29-31 and the other occurrences at 53-55, 84-86, 108-110) by
changing the opening fence from ``` to ```text so the path-only blocks are
explicitly tagged as text.
Comment on lines
+162
to
+179
| ```json title="$$ACCOUNT_NAME$$/_global/bootstrap/custom_plan_iam_policy.json" | ||
| { | ||
| "Version": "2012-10-17", | ||
| "Statement": [ | ||
| // ... existing statements ... | ||
| { | ||
| "Sid": "SageMakerReadOnlyAccess", | ||
| "Effect": "Allow", | ||
| "Action": [ | ||
| "sagemaker:Describe*", | ||
| "sagemaker:List*", | ||
| "sagemaker:Get*" | ||
| ], | ||
| "Resource": "*" | ||
| } | ||
| ] | ||
| } | ||
| ``` |
Contributor
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Verify that JSON fences contain line comments in this doc.
rg -n '```json title=' docs/2.0/docs/pipelines/guides/updating-plan-apply-roles.md -A25 \
| rg -n '// \.\.\. existing statements \.\.\.'Repository: gruntwork-io/docs
Length of output: 227
Use jsonc fences for commented JSON snippets.
These examples include // ... existing statements ...; with json fences, readers may assume the content is copy-pastable strict JSON. Using jsonc (JSON with Comments) clarifies that comments are permitted in these examples.
Suggested patch
-```json title="$$ACCOUNT_NAME$$/_global/bootstrap/custom_plan_iam_policy.json"
+```jsonc title="$$ACCOUNT_NAME$$/_global/bootstrap/custom_plan_iam_policy.json"
@@
-```json title="$$ACCOUNT_NAME$$/_global/bootstrap/custom_apply_iam_policy.json"
+```jsonc title="$$ACCOUNT_NAME$$/_global/bootstrap/custom_apply_iam_policy.json"
@@
-```json title="$$ACCOUNT_NAME$$/_global/bootstrap/custom_plan_iam_policy.json"
+```jsonc title="$$ACCOUNT_NAME$$/_global/bootstrap/custom_plan_iam_policy.json"
@@
-```json title="$$ACCOUNT_NAME$$/_global/bootstrap/custom_apply_iam_policy.json"
+```jsonc title="$$ACCOUNT_NAME$$/_global/bootstrap/custom_apply_iam_policy.json"Also applies to: lines 183-198, 324-341, 345-360
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2.0/docs/pipelines/guides/updating-plan-apply-roles.md` around lines 162
- 179, Update the fenced code blocks that contain commented JSON examples to use
jsonc instead of json so readers know comments are allowed; specifically change
the code fence languages for the snippets titled
"$$ACCOUNT_NAME$$/_global/bootstrap/custom_plan_iam_policy.json" and
"$$ACCOUNT_NAME$$/_global/bootstrap/custom_apply_iam_policy.json" (and the other
occurrences called out in the review at the later ranges) from ```json to
```jsonc so the inline comments like "// ... existing statements ..." are valid
and the examples are not mistaken for strict JSON.
Contributor
Looks great apart from these nits. Very happy to have this documented. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary by CodeRabbit