Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Rulesets docs don't disclose that bypass_actors is not honored by auto-merge completion

Ouverte Adaptée aux débutants
#45,265 3 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
76/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Calme
Stack technique
github
Domaine
documentation

Piste de recherche

Commencez par les deux pages Rulesets concernées : “Creating rulesets for a repository” et “Available rules for rulesets”, en particulier les sections consacrées à la liste de bypass et aux règles de pull request. Examinez le comportement de auto-merge signalé et ajoutez une note claire sur la limitation couvrant bypass_actors et la finalisation de auto-merge ; l’issue est terminée lorsque les deux pages pertinentes expliquent correctement ce comportement.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

content needs SME never-stale repositories Waiting on SME review
Page(s) affected
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_request rule, require_code_owner_review: true, required_approving_review_count: 1, with a GitHub App added to bypass_actors (Integration type; tested both bypass_mode: "always" and "pull_request").
  • A PR approved by the bypass-listed actor with auto-merge enabled (gh pr merge --auto --squash) stayed mergeStateStatus: BLOCKED / reviewDecision: REVIEW_REQUIRED indefinitely — 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)
Langage dominant
TypeScript
Étoiles
20.9k
Forks
68.8k
Merge moyen
13 h 7 min
PR mergées (30 j)
116

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de github/docs

Toutes les issues de github/docs

Issues similaires

Plus d'issues TypeScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.