注釈: プルリクエストにおける特別なキーワードは、プルリクエストがリポジトリのデフォルト ブランチをターゲットするときに解釈されます。 ただし、PRのベースがそれ以外のブランチである場合、それらのキーワードは無視され、リンクは作成されません。PRのマージはこのIssueに対して何の効果も持ちません。 キーワードの1つを使用してプルリクエストをIssueにリンクしたい場合は、PRがデフォルトブランチ上になければなりません。
リンクされたIssueとプルリクエストについて
You can link an issue to a pull request using a supported keyword in the pull request description.
プルリクエストが対処するIssueにそのプルリクエストにリンクすると、コラボレータは、誰かがそのIssueに取り組んでいることを確認できます。 プルリクエストとIssueが別のリポジトリにある場合は、プルリクエストをマージするユーザーにIssueをクローズする権限もあれば、そのマージが実行された後でGitHub Enterprise Serverにリンクが表示されます。
リンクされたプルリクエストをリポジトリのデフォルトブランチにマージすると、それにリンクされている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はクローズされますが、そのコミットを含むプルリクエストは、リンクされたプルリクエストとしてリストされません。