PF-119: Account Factory should be able to vend in a subdirectory#3139
PF-119: Account Factory should be able to vend in a subdirectory#3139gruntwork-ci wants to merge 1 commit into
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughThis PR adds documentation for a new ChangesAccount Factory new_account_parent_path Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/2.0/reference/accountfactory/configurations-as-code.md`:
- Around line 306-319: The example HCL block under the new_account_parent_path
description is currently indented and parsed as an indented code block; replace
it with a fenced code block using the language tag "hcl" and unindented contents
so markdownlint rule MD046 is satisfied—for example, wrap the account_factory {
new_account_parent_path = "aws" } snippet in ```hcl ... ``` and ensure the block
uses the exact symbol names account_factory and new_account_parent_path as
shown.
🪄 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: 588d7193-62cf-41c5-81f3-ebad0e7f4d0a
📒 Files selected for processing (2)
docs/2.0/docs/accountfactory/architecture/index.mddocs/2.0/reference/accountfactory/configurations-as-code.md
| A repo-relative subdirectory under which newly vended accounts are created. When set to a value such as `"aws"`, Account Factory will vend new AWS accounts into `{repo_root}/aws/{account_name}/…` instead of `{repo_root}/{account_name}/…`. The default is `""`, meaning new accounts are vended at the repository root (today's behavior). | ||
| <br /> | ||
| This setting affects only newly vended accounts. Existing accounts are not relocated, and the `_new-account-requests/` directory and the `accounts.yml` file continue to live at the repository root. | ||
| <br /> | ||
| The value must be a relative subpath. Leading and trailing slashes are stripped silently (`"/aws/"` is equivalent to `"aws"`). Paths containing `..` segments are rejected at config-load time. | ||
|
|
||
| </HclListItemDescription> | ||
| <HclListItemExample> | ||
|
|
||
| ```hcl | ||
| account_factory { | ||
| new_account_parent_path = "aws" | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Fix Markdown code-block style to satisfy MD046 in this new section.
The newly added example snippets are being parsed as indented-style blocks by markdownlint. Please switch them to explicit fenced style in this section so doc lint stays clean.
Suggested adjustment
- A repo-relative subdirectory under which newly vended accounts are created. When set to a value such as `"aws"`, Account Factory will vend new AWS accounts into `{repo_root}/aws/{account_name}/…` instead of `{repo_root}/{account_name}/…`. The default is `""`, meaning new accounts are vended at the repository root (today's behavior).
+ A repo-relative subdirectory under which newly vended accounts are created. When set to a value such as `"aws"`, Account Factory will vend new AWS accounts into `{repo_root}/aws/{account_name}/…` instead of `{repo_root}/{account_name}/…`. The default is `""`, meaning new accounts are vended at the repository root (today's behavior).
@@
- ```hcl
- account_factory {
- new_account_parent_path = "aws"
- }
- ```
+```hcl
+account_factory {
+ new_account_parent_path = "aws"
+}
+```🧰 Tools
🪛 markdownlint-cli2 (0.22.1)
[warning] 306-306: Code block style
Expected: fenced; Actual: indented
(MD046, code-block-style)
[warning] 315-315: Code block style
Expected: fenced; Actual: indented
(MD046, code-block-style)
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/2.0/reference/accountfactory/configurations-as-code.md` around lines 306
- 319, The example HCL block under the new_account_parent_path description is
currently indented and parsed as an indented code block; replace it with a
fenced code block using the language tag "hcl" and unindented contents so
markdownlint rule MD046 is satisfied—for example, wrap the account_factory {
new_account_parent_path = "aws" } snippet in ```hcl ... ``` and ensure the block
uses the exact symbol names account_factory and new_account_parent_path as
shown.
1 participant
Implements plan for Linear issue PF-119.
Plan source: https://github.com/gruntwork-io-team/linear-claude-plans/blob/main/plans/PF-119.md
Claude's implementation summary
Related PRs in this change set
Summary by CodeRabbit
Release Notes
new_account_parent_pathconfiguration attribute, enabling customization of the parent directory for newly vended accounts while maintaining the request directory and configuration file at the repository root.