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
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 82/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Ativa
- Stack de tecnologia
- github
- Domínio
- documentation
Direção de pesquisa
Comece pelo artigo creating-a-branch-for-an-issue vinculado no relatório e compare a redação sobre vinculação automática com a do artigo vinculado sobre pull requests. Confirme a condição documentada da branch padrão e atualize o trecho afetado para que corresponda ao comportamento observado. O trabalho estará concluído quando o artigo explicar claramente quando ocorre a vinculação automática e as verificações de documentação relevantes forem aprovadas.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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.
- Linguagem predominante
- TypeScript
- Estrelas
- 20.9k
- Forks
- 68.8k
- Merge médio
- 15h 4min
- PRs com merge (30d)
- 103
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de github/docs
-
builder persona content
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 90/100
-
localization
Dificuldade 2/5 1-2 dias Facilidade para iniciantes 72/100
-
content localization
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
-
content localization
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 92/100
-
content dependabot needs SME
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 82/100
Todas as issues de github/docs
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 84/100
Eynzof/Hermes-CN-Desktop#610 ·
-
[Bug]: Matrix progress drafts fail with "Matrix runtime not initialized" during tool activity Abertabug clawsweeper:linked-pr-open clawsweeper:needs-live-repro clawsweeper:no-new-fix-pr impact:message-loss issue-rating: 🐚 platinum hermit P2 regression
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
-
enhancement
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
-
calcite-components needs triage refactor
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
Esri/calcite-design-system#15203 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 90/100
danielmiessler/LifeOS#2218 ·