Pull RequestをIssueにリンクする

pull request またはブランチを Issue にリンクすると、現在修正プログラムが準備中であることを示し、pull request またはブランチがマージされたとき、自動的に Issue を閉じることができます。

この記事の内容

リンクされたIssueとPull Requestについて

Issue を pull request にリンクするには、手動で行うか、pull request の説明 (つまり、pull request の作成時に作成者が追加した要約テキスト) でサポートされているキーワードを使います。

Pull Requestが対処するIssueにそのPull Requestをリンクすると、コラボレータは、誰かがそのIssueに取り組んでいることを確認できます。

リンクされた pull request をリポジトリの既定のブランチにマージすると、それにリンクされている issue は自動的にクローズされます。既定のブランチの詳細については、「デフォルトブランチを変更する」を参照してください。

Note

Pull request の説明に含まれる特殊なキーワードが解釈されるのは、pull request がリポジトリの "既定の" ブランチをターゲットにしている場合のみです。__ Pull request が "それ以外のブランチ" をターゲットにしている場合、これらのキーワードは無視され、リンクは作成されません。また、PR をマージしても issue には何の効果もありません。__

キーワードを使用してPull RequestをIssueにリンクする

pull request の説明またはコミットメッセージでサポートされているキーワードを使用して、pull request に issue にリンクできます。 pull request は、既定のブランチに存在する必要があります。

close
closes
closed
fix
fixes
fixed
resolve
resolves
resolved

他のPull RequestでPull Requestのコメントを参照するためにキーワードを使用すると、Pull Requestはリンクされます。参照元の pull request をマージすると、参照先の pull request もクローズされます。

クローズするキーワードの構文は、IssueがPull Requestと同じリポジトリにあるかどうかによって異なります。

リンクする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`

手動でリンクされた pull request のみを手動でリンク解除できます。キーワードを使用してリンクした issue のリンクを解除するには、pull request の説明を編集してそのキーワードを削除する必要があります。

クローズするキーワードは、コミットメッセージでも使用できます。デフォルトブランチにコミットをマージするとIssueはクローズされますが、そのコミットを含むPull Requestは、リンクされたPull Requestとしてリストされません。

リポジトリへの書き込み権限があるユーザーなら誰でも、Pull Request サイドバーから Pull Request を手動で Issue にリンクできます。

手動で1つのPull Requestごとに最大10個のIssueをリンクできます。 IssueとPull Requestは同じリポジトリになければなりません。