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

Aperta Adatta ai principianti
#45,948 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
github
Ambito
documentation

Direzione di ricerca

Inizia con l’articolo creating-a-branch-for-an-issue collegato nel report e confronta la formulazione relativa al collegamento automatico con quella dell’articolo collegato sulle pull request. Conferma la condizione documentata relativa al branch predefinito e aggiorna il passaggio interessato in modo che corrisponda al comportamento osservato. Il lavoro è completato quando l’articolo spiega chiaramente quando avviene il collegamento automatico e i controlli della documentazione pertinenti hanno esito positivo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

builder persona triage
Code of Conduct
What article on docs.github.com is affected?

https://docs.github.com/en/issues/tracking-your-work-with-issues/using-issues/creating-a-branch-for-an-issue

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):

  1. Create issue A. From its Development section, use "Create a branch" to create linked branch feature/a.
  2. Create issue B. Create linked branch feature/b the same way, based on feature/a.
  3. Push a commit to feature/b and open a pull request from feature/b with base feature/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 (closingIssuesReferences becomes 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 closingIssuesReferences through 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.
Lingua principale
TypeScript
Stelle
20.9k
Fork
68.8k
Merge medio
13h 55m
PR unite (30g)
105

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di github/docs

Tutte le issue di github/docs

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.