Rulesets docs don't disclose that bypass_actors is not honored by auto-merge completion
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 2/5
- Tempo stimato
- 1-3 ore
- Idoneità per principianti
- 76/100
- Tipo di issue
- Documentazione
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Tranquilla
- Stack tecnologico
- github
- Ambito
- documentation
Direzione di ricerca
Inizia con le due pagine interessate di Rulesets: “Creating rulesets for a repository” e “Available rules for rulesets”, in particolare le sezioni sull’elenco di bypass e sulle regole delle pull request. Esamina il comportamento di auto-merge segnalato e aggiungi una nota chiara sulla limitazione che copra bypass_actors e il completamento di auto-merge; l’issue è completata quando entrambe le pagine pertinenti spiegano accuratamente questo comportamento.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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
- Lingua principale
- TypeScript
- Stelle
- 20.9k
- Fork
- 68.8k
- Merge medio
- 15h 4m
- PR unite (30g)
- 103
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di github/docs
-
content triage
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 90/100
-
localization triage
Difficoltà 2/5 1-2 giorni Idoneità per principianti 72/100
-
builder persona triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
-
content localization
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
-
content localization
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
Issue simili
-
bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
-
Add: Star Sports 2 Telugu HD Apertacheck:passed streams:add
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100