Rulesets docs don't disclose that bypass_actors is not honored by auto-merge completion
還沒有人認領這個 Issue。
評估
- 難度
- 2/5
- 預估耗時
- 1-3 小時
- 新手友好度
- 76/100
- Issue 類型
- 文件
- 描述清晰度
- 描述清楚
- 活躍度
- 冷清
- 技術堆疊
- github
研究方向
從受影響的兩個 Rulesets 頁面開始:「Creating rulesets for a repository」和「Available rules for rulesets」,尤其是 bypass 清單和提取要求規則區段。檢視回報的 auto-merge 行為,並新增一則清楚的限制說明,涵蓋 bypass_actors 和 auto-merge 完成;當兩個相關頁面都準確說明此行為時,該 issue 即完成。
由索引模型根據 Issue 內容生成。
描述
Page(s) affected
- https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/creating-rulesets-for-a-repository
- https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets (bypass list / pull request rule sections)
What's wrong
The Rulesets documentation describes bypass_actors (a Team, Role, GitHub App/Integration, etc. added to a ruleset's bypass list) as being able to bypass a rule such as "Require a pull request before merging" / "Require review from Code Owners". It does not document an important limitation we've confirmed by testing: the bypass grant is only honored by a synchronous, direct merge call — it is not consulted by GitHub's async auto-merge completion process (gh pr merge --auto, enablePullRequestAutoMerge, or the "Merge when ready" UI button).
Repro / evidence
- Ruleset:
pull_requestrule,require_code_owner_review: true,required_approving_review_count: 1, with a GitHub App added tobypass_actors(Integrationtype; tested bothbypass_mode: "always"and"pull_request"). - A PR approved by the bypass-listed actor with auto-merge enabled (
gh pr merge --auto --squash) stayedmergeStateStatus: BLOCKED/reviewDecision: REVIEW_REQUIREDindefinitely — confirmed via a clean 10-minute poll (every 20s, 30/30 polls) with a fresh trigger event and zero manual intervention. - The same PR, same bypass-eligible actor, merged instantly when calling the merge endpoint directly instead:
gh api repos/OWNER/REPO/pulls/N/merge -X PUT -f merge_method=squash
So the bypass mechanism works, but only for one of the two documented ways to merge a PR, and the docs don't call this out anywhere.
What we'd like to see
A note on the bypass_actors / rules pages clarifying that bypass grants are not currently honored by auto-merge completion, and that automation relying on bypass should call the merge endpoint directly rather than enabling auto-merge, until/unless this is fixed at the platform level.
Related reports (same underlying platform behavior, not a docs-only issue)
- https://github.com/orgs/community/discussions/162623
- https://github.com/orgs/community/discussions/190610
- https://github.com/orgs/community/discussions/113172
- https://github.com/orgs/community/discussions/167357
- https://github.com/orgs/community/discussions/136531
- https://github.com/cli/cli/issues/13388
- https://github.com/cli/cli/issues/13458
- 主要語言
- TypeScript
- 星號
- 20.9k
- 分支
- 68.8k
- 平均合併
- 15 小時 4 分鐘
- 30 天內合併 PR
- 103
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
github/docs 的其他 Issue
-
builder persona content
難度 1/5 1 小時以內 新手友好度 90/100
-
localization
難度 2/5 1-2 天 新手友好度 72/100
-
builder persona
難度 2/5 1-3 小時 新手友好度 82/100
-
content localization
難度 2/5 1-3 小時 新手友好度 78/100
-
content localization
難度 1/5 1 小時以內 新手友好度 92/100
相似的 Issue
-
comp/desktop P3 type/bug
難度 1/5 1 小時以內 新手友好度 92/100
NousResearch/hermes-agent#118866 ·
-
Browser Waiting for: Product Owner
難度 2/5 1-3 小時 新手友好度 85/100
getsentry/sentry-javascript#24577 · 1 則留言 ·
-
難度 2/5 1-3 小時 新手友好度 78/100
agilepathway/label-checker#640 ·
-
Plugin stuck at "loading" on DSH 0.1.6-alpha.2 — turnTail list slot registration missing options.id 未關閉
難度 2/5 1-3 小時 新手友好度 88/100
-
難度 2/5 1-3 小時 新手友好度 68/100
chrisparsons83/flexspotff#153 ·