Rulesets docs don't disclose that bypass_actors is not honored by auto-merge completion
まだ誰も着手していません。
評価
- 難易度
- 2/5
- 見積もり時間
- 1〜3時間
- 初心者へのやさしさ
- 76/100
- issue の種類
- ドキュメント
- 明瞭さ
- 明確に書かれている
- 活発さ
- 静か
- 技術スタック
- github
調査の方向性
影響を受ける2つの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分
- マージ済み PR(30日)
- 103
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- 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
-
S: triage
難易度 1/5 1時間未満 初心者へのやさしさ 85/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
fix(errors): EHOSTUNREACH from a happy-eyeballs connect is reported as a resolver error (STAMP-80) オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 90/100
snapshot-labs/stamp#666 ·
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
GauravKarakoti/SecureFlow#1070 · コメント 1 件 ·
-
feature:Languages/Translations good first issue ready Web
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
digitalfabrik/integreat-app#4394 ·