Add account_factory.pr_create_token_name hcl config#3092
Add account_factory.pr_create_token_name hcl config#3092Resonance1584 wants to merge 1 commit intomainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughA documentation update that introduces a new optional Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 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/reference/accountfactory/configurations-as-code.md`:
- Around line 323-327: The HclListItemDescription for HclListItem
name="pr_create_token_name" is being interpreted as an indented code block
(markdownlint MD046); fix it by changing the description line so it’s normal
prose—either remove the leading indentation on the text line or wrap the
description in a paragraph tag (e.g., use <p>...</p>) within the
HclListItemDescription block so the text is parsed as regular markdown.
🪄 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: 0251c9cb-994c-4c25-89e5-00e867966d57
📒 Files selected for processing (1)
docs/2.0/reference/accountfactory/configurations-as-code.md
| <HclListItem name="pr_create_token_name" requirement="optional" type="string"> | ||
| <HclListItemDescription> | ||
|
|
||
| (GitHub only) The name of your PR create token if different from the default of `PR_CREATE_TOKEN`. | ||
|
|
There was a problem hiding this comment.
Address markdownlint MD046 on the description line.
Line 326 is being parsed as an indented code block by markdownlint. Please reformat this description so it’s treated as normal prose (e.g., wrap in <p>...</p> or remove leading indentation for the text line).
Suggested fix
<HclListItem name="pr_create_token_name" requirement="optional" type="string">
<HclListItemDescription>
-
- (GitHub only) The name of your PR create token if different from the default of `PR_CREATE_TOKEN`.
-
+ <p>(GitHub only) The name of your PR create token if different from the default of <code>PR_CREATE_TOKEN</code>.</p>
</HclListItemDescription>
</HclListItem>📝 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.
| <HclListItem name="pr_create_token_name" requirement="optional" type="string"> | |
| <HclListItemDescription> | |
| (GitHub only) The name of your PR create token if different from the default of `PR_CREATE_TOKEN`. | |
| <HclListItem name="pr_create_token_name" requirement="optional" type="string"> | |
| <HclListItemDescription> | |
| <p>(GitHub only) The name of your PR create token if different from the default of <code>PR_CREATE_TOKEN</code>.</p> | |
| </HclListItemDescription> | |
| </HclListItem> |
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 326-326: Code block style
Expected: fenced; Actual: indented
(MD046, code-block-style)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/2.0/reference/accountfactory/configurations-as-code.md` around lines 323
- 327, The HclListItemDescription for HclListItem name="pr_create_token_name" is
being interpreted as an indented code block (markdownlint MD046); fix it by
changing the description line so it’s normal prose—either remove the leading
indentation on the text line or wrap the description in a paragraph tag (e.g.,
use <p>...</p>) within the HclListItemDescription block so the text is parsed as
regular markdown.
Summary by CodeRabbit
pr_create_token_namethat enables customization of the token name default.