注釈: プルリクエストにおける特別なキーワードは、プルリクエストがリポジトリのデフォルト ブランチをターゲットするときに解釈されます。 ただし、PRのベースがそれ以外のブランチである場合、それらのキーワードは無視され、リンクは作成されません。PRのマージはこのIssueに対して何の効果も持ちません。 キーワードの1つを使用してプルリクエストをIssueにリンクしたい場合は、PRがデフォルトブランチ上になければなりません。
リンクされたIssueとプルリクエストについて
手動で、またはプルリクエストの説明でサポートされているキーワードを使用して、Issueをプルリクエストにリンクすることができます。
プルリクエストが対処するIssueにそのプルリクエストにリンクすると、コラボレータは、誰かがそのIssueに取り組んでいることを確認できます。
リンクされたプルリクエストをリポジトリのデフォルトブランチにマージすると、それにリンクされているIssueは自動的にクローズされます。 デフォルトブランチの詳細については、「デフォルトブランチを変更する」を参照してください。
キーワードを使用してプルリクエストをIssueにリンクする
プルリクエストの説明で、またはコミットメッセージで、サポートされているキーワードを使用してプルリクエストにIssueにリンクすることができます (プルリクエストはデフォルトブランチになければなりません)。
- close
- closes
- closed
- fix
- fixes
- fixed
- 解決
- resolves
- resolved
クローズするキーワードの構文は、Issueがプルリクエストと同じリポジトリにあるかどうかによって異なります。
リンクするIssue | 構文 | サンプル |
---|---|---|
Issueが同じリポジトリにある | KEYWORD #ISSUE-NUMBER | Closes #10 |
Issueが別のリポジトリにある | KEYWORD OWNER/REPOSITORY#ISSUE-NUMBER | Fixes octo-org/octo-repo#100 |
複数の Issue | Issueごとに完全な構文を使用 | Resolves #10, resolves #123, resolves octo-org/octo-repo#100 |
手動でリンクを解除できるのは、手動でリンクされたプルリクエストだけです。 キーワードを使用してリンクしたIssueのリンクを解除するには、プルリクエストの説明を編集してそのキーワードを削除する必要があります。
クローズするキーワードは、コミットメッセージでも使用できます。 デフォルトブランチにコミットをマージするとIssueはクローズされますが、そのコミットを含むプルリクエストは、リンクされたプルリクエストとしてリストされません。
手動でプルリクエストをIssueにリンクする
リポジトリへの書き込み権限があるユーザなら誰でも、手動でプルリクエストをIssueにリンクできます。
手動で1つのプルリクエストごとに最大10個のIssueをリンクできます。 Issueとプルリクエストは同じリポジトリになければなりません。
- GitHub Enterprise Serverで、リポジトリのメインページにアクセスしてください。
- リポジトリ名の下で、クリックします Pull requests
- プルリクエストのリストで、Issueにリンクしたいプルリクエストをクリックします。
- 右のサイドバーで、[Linked issues] をクリックします。
- プルリクエストにリンクするIssueをクリックします。