Skip to content

docs: 新增配置开关速查表 - #106

Merged
lwpk110 merged 1 commit into
mainfrom
docs/config-cheatsheet
Aug 15, 2026
Merged

lwpk110 merged 1 commit into
mainfrom
docs/config-cheatsheet

Conversation

@lwpk110

@lwpk110 lwpk110 commented Aug 15, 2026 •

Copy link
Copy Markdown
Owner

变更概述

README 新增「配置开关速查」章节:一张表列出所有能力对应的开关/参数与设置位置,直接回答「设置什么参数开启什么能力」。

变更内容

  • 新增速查表,覆盖 15 项能力:
    • 触发:auto_review: true 开启 PR 打开自动审核(默认仅按需)、@CoderHeimdall 手动触发
    • 模型:AI_PROVIDER / AI_MODEL / AI_BASE_URL / 各提供方 base_url
    • 审查范围:include / exclude / min_severity / instructions / manual_reviewers
    • 阻断:block_on_critical + 分支保护
    • 其他:MAX_DIFF_LENGTH
  • 明确「在哪设置」(环境变量 / Actions Variable / .github/heimdall.yml / wrangler.toml)

验证

  • markdown 围栏配对 ✅

Summary by CodeRabbit

  • 文档
    • 新增“配置开关速查”章节。
    • 汇总自动审核、手动触发、AI 提供方与模型、代理地址、Diff 长度、文件过滤、严重度阈值、自定义指令、触发白名单及严重问题阻断等配置项。
    • 补充各配置项的设置位置与默认行为说明。

@coderabbitai

coderabbitai Bot commented Aug 15, 2026 •

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 6416bf38-6673-42ce-83b1-894f8e468271

📥 Commits

Reviewing files that changed from the base of the PR and between cec4728 and c1f3030.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

README.md 新增“配置开关速查”章节。章节说明审核触发、AI 配置、文件过滤、严重度阈值、自定义指令、白名单和 critical 阻断配置。

Changes

配置说明

Layer / File(s) Summary
配置开关速查表
README.md
新增配置参数表。内容涵盖审核触发方式、AI 提供方与模型、代理地址、diff 长度、文件过滤、严重度阈值、自定义指令、手动审核白名单和 critical 阻断。章节同时说明环境变量、Worker、Actions 的配置位置及默认行为。

Estimated code review effort: 1 (简单) | ~3 分钟

Poem

我是小兔,翻过配置草地,
找到开关,排成整齐队列。
AI、diff、阈值都写清,
critical 亮起红色警铃。
README 轻轻合上耳朵,
审核路径不再迷路。

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/config-cheatsheet

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.

❤️ Share

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

@lwpk110
lwpk110 merged commit b274589 into main Aug 15, 2026
1 of 2 checks passed
@lwpk110
lwpk110 deleted the docs/config-cheatsheet branch August 15, 2026 15:04
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