Docs say a PR from a linked branch is "automatically linked" to the issue, but it is not when the PR targets a non-default branch
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 2/5
- Temps estimé
- 1-3 heures
- Accessibilité débutants
- 82/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- Active
- Stack technique
- github
- Domaine
- documentation
Piste de recherche
Commencez par l’article creating-a-branch-for-an-issue lié dans le rapport et comparez sa formulation concernant la liaison automatique avec celle de l’article lié sur les pull requests. Confirmez la condition documentée relative à la branche par défaut et mettez à jour le passage concerné afin qu’il corresponde au comportement observé. Le travail est terminé lorsque l’article explique clairement quand la liaison automatique se produit et que les vérifications de documentation concernées réussissent.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
What part(s) of the article would you like to see updated?
The article states, with no condition on the pull request's base branch:
When you create a pull request for a branch that's connected to an issue, it is automatically linked to the issue, and the connection with that branch is removed with only the pull request shown in the "Development" section.
In practice this automatic linking does not happen when the pull request targets a branch other than the repository's default branch. The article should either state that the automatic linking requires the pull request to target the default branch, or the behaviour should be changed to match the current wording.
For comparison, the default-branch requirement is documented for closing keywords on Linking a pull request to an issue ("The pull request must be on the default branch."). There is no equivalent caveat on this page, so readers who create a branch from an issue reasonably expect the link to be created regardless of the base branch.
Additional information
Steps to reproduce (reproduced reliably, on a repository whose default branch is main):
- Create issue A. From its Development section, use "Create a branch" to create linked branch
feature/a. - Create issue B. Create linked branch
feature/bthe same way, based onfeature/a. - Push a commit to
feature/band open a pull request fromfeature/bwith basefeature/a(a stacked pull request).
Expected (per the article): issue B's Development section shows the pull request in place of the branch, and the pull request's closingIssuesReferences contains issue B.
Actual: issue B's Development section still shows the branch, and no pull request appears there. The pull request's closingIssuesReferences is empty, and no connected event is emitted on the issue timeline — only cross-referenced.
Repeating step 3 with base = main behaves exactly as documented: a connected event is emitted about two seconds after the pull request is created, and the branch entry is replaced by the pull request.
Notes
- Manually linking that same pull request to the issue from the Development sidebar does work with a non-default base, and the resulting link is a normal one (
closingIssuesReferencesbecomes populated). So this is not a blanket restriction on non-default base branches — only the automatic linking silently does not run. That asymmetry is what makes the current wording misleading. - Why this matters: in a stacked pull request workflow every pull request except the first one targets a non-default branch, so each one silently loses its issue link. Nothing in the UI indicates that the link is missing; it is only visible by querying
closingIssuesReferencesthrough the API, or by noticing that the Development section still lists a branch rather than a pull request. - Related, but not the same request: https://github.com/orgs/community/discussions/13240 asks for linked issues to be closed when a pull request merges into a non-default branch. This report is about the link not being created at all, which happens even before any merge.
- Langage dominant
- TypeScript
- Étoiles
- 20.9k
- Forks
- 68.8k
- Merge moyen
- 13 h 55 min
- PR mergées (30 j)
- 105
Guide de contribution
Ouvrir le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de github/docs
-
content triage
Difficulté 1/5 Moins d'une heure Accessibilité débutants 90/100
-
localization triage
Difficulté 2/5 1-2 jours Accessibilité débutants 72/100
-
content localization
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
-
content localization
Difficulté 1/5 Moins d'une heure Accessibilité débutants 92/100
-
content dependabot needs SME
Difficulté 1/5 Moins d'une heure Accessibilité débutants 82/100
Toutes les issues de github/docs
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
-
area:tools bug good first issue help wanted priority:P2
Difficulté 2/5 1-3 heures Accessibilité débutants 90/100
TaewoooPark/Motifcode#14 ·
-
bug 🐞
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
-
[Bounty proposal] fix(web): memory insights count an evening memory on the next day ($25 proposed) Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 84/100
BasedHardware/omi#15320 ·
-
Difficulté 2/5 Une demi-journée Accessibilité débutants 78/100
vercel/vercel-plugin#199 ·