Skip to content

Add account_factory.pr_create_token_name hcl config#3092

Open
Resonance1584 wants to merge 1 commit intomainfrom
2026-04-17_add-pr-create-token-hcl
Open

Add account_factory.pr_create_token_name hcl config#3092
Resonance1584 wants to merge 1 commit intomainfrom
2026-04-17_add-pr-create-token-hcl

Conversation

@Resonance1584
Copy link
Copy Markdown
Contributor

@Resonance1584 Resonance1584 commented Apr 17, 2026

Summary by CodeRabbit

  • Documentation
    • Added documentation for a new optional GitHub configuration option pr_create_token_name that enables customization of the token name default.

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 17, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Apr 17, 2026 8:11pm

Request Review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 17, 2026

Walkthrough

A documentation update that introduces a new optional pr_create_token_name configuration attribute for the account_factory block, enabling GitHub token name customization with a default override for PR_CREATE_TOKEN.

Changes

Cohort / File(s) Summary
Documentation Reference
docs/2.0/reference/accountfactory/configurations-as-code.md
Added optional pr_create_token_name attribute documentation for the account_factory configuration, enabling GitHub-specific token name customization.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

📖 A token name to call your own,

No more default, a choice you've grown,

GitHub whispers, "Customize with ease,"

Documentation blooms to perfectly please! 🌟

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main change: documenting a new optional pr_create_token_name attribute in the account_factory HCL configuration.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch 2026-04-17_add-pr-create-token-hcl

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a 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

🤖 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

📥 Commits

Reviewing files that changed from the base of the PR and between 196c2f0 and f9258c2.

📒 Files selected for processing (1)
  • docs/2.0/reference/accountfactory/configurations-as-code.md

Comment on lines +323 to +327
<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`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

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.

Suggested change
<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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant