Docs PR Review Adapter¶
生成时间:2026-06-14T12:05:41.093407+00:00
本页是 GitHub PR review adapter 接入前的本地契约。它只消费安全的 changed path 列表,把 Docs Publish Review 的页面审查规则映射成 PR comment、required reviewer 和 check run 请求;不保存 raw diff、PR URL、Actions run URL、完整 SHA、cookie 或临时 token。
汇总¶
- changed path 数:7
- review request 数:5
- ignored path 数:1
- unsafe payload leak 数:0
Safe Input Contract¶
输入只允许 repo-relative path、change_type 和来源类型。真实 GitHub adapter 后续可读取 gh pr view --json files 或 GitHub API 的 files 列表,但必须先投影成同一份 changed path 摘要,再进入本模块。
Review Requests¶
| Target | Kind | Trigger Paths | Actions | Gates | Reviewers | GitHub Delivery |
|---|---|---|---|---|---|---|
.github/workflows/ci.yml |
repository_governance |
.github/workflows/ci.yml |
ci_gate_review |
ci_required_gates_present |
engineering-maintainer |
pull_request_comment, required_reviewer, check_run:ci_gate_review |
docs/knowledge/docs-publish-review.md |
docs_publish_page |
docs/knowledge/docs-publish-review.mdframework/governance/docs_publish_review.py |
regenerate_source_review |
source_registry_or_generator_updated |
automation-maintainer |
pull_request_comment, required_reviewer, check_run:docs-publish-review/generated |
docs/knowledge/github-actions-run-ledger.md |
docs_publish_page |
docs/knowledge/github-actions-run-ledger.md |
regenerate_source_review, sanitization_review |
source_registry_or_generator_updated, sanitized_fixture_only |
automation-maintainer, security-reviewer |
pull_request_comment, required_reviewer, check_run:docs-publish-review/generated |
mkdocs.yml |
repository_governance |
mkdocs.yml |
mkdocs_nav_review |
mkdocs_strict_build_passed |
automation-maintainer |
pull_request_comment, required_reviewer, check_run:mkdocs_nav_review |
scripts/check.ps1 |
repository_governance |
scripts/check.ps1 |
local_check_script_review |
local_check_matches_ci |
engineering-maintainer |
pull_request_comment, required_reviewer, check_run:local_check_script_review |
Ignored Paths¶
| Path | Reason |
|---|---|
tests/test_docs_publish_review.py |
no docs publish or repository governance review rule |
与真实 GitHub Adapter 的关系¶
- PR adapter 读取 changed files 后,只把路径级摘要交给本模块。
- 本模块输出 request 后,adapter 再转成 GitHub review comment、required reviewer 或 check run。
generated页面只评论“改源数据后重新生成”,不评论 raw diff 内容。case_study页面必须附加sanitization_review,确认真实实践问题已经变成 sanitized fixture。- 真实 adapter 接入后,
PR/Docs Health Loop的requires_review_comment_polling才能被替换为可验证的 live review 状态。