Pull RequestをIssueにリンクする

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

この記事の内容

Note

pull request の説明で使用される特別なキーワードは、その pull request がリポジトリの "既定の" ブランチをターゲットにしている場合に解釈されます。__ ただし、PR のベースが_それ以外のブランチ_である場合、それらのキーワードは無視され、リンクは作成されません。PR のマージはこの issue に対して何の効果も持ちません。 キーワードの 1 つを使って pull request を issue にリンクする場合、PR が既定ブランチ上になければなりません。

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

手動か、pull request の説明でサポートされているキーワードを使い、pull request に issue にリンクできます。

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

リンクされたPull Requestをリポジトリのデフォルトブランチにマージすると、それにリンクされている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-NUMBERCloses #10
Issueが別のリポジトリにあるKEYWORD OWNER/REPOSITORY#ISSUE-NUMBERFixes octo-org/octo-repo#100
複数の IssueIssueごとに完全な構文を使用Resolves #10, resolves #123, resolves octo-org/octo-repo#100

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

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

Pull Request を Issue に Pull Request サイドバーを使用して手動でリンクする

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

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

  1. GitHub で、リポジトリのメイン ページに移動します。

  2. リポジトリ名の下にある [pull request] をクリックします。

    リポジトリのメイン ページのスクリーンショット。 水平ナビゲーション バーでは、[pull request] というラベルが付いたタブが濃いオレンジ色の枠線で囲まれています。

  3. Pull Requestのリストで、IssueにリンクしたいPull Requestをクリックします。

  4. 右側のサイドバーで、 [開発] をクリックします。

    issue サイドバーのスクリーンショット。 [開発] が濃いオレンジ色の枠線で囲まれています。

  5. Pull RequestにリンクするIssueをクリックします。

Pull Request またはブランチを Issue サイドバーを使用して手動でリンクする

リポジトリへの書き込み権限があるユーザーなら誰でも、手動で Pull Request またはブランチを Issue にリンクできます。

手動で1つのPull Requestごとに最大10個のIssueをリンクできます。 Issue のリポジトリは、リンクした Pull Request またはブランチとは別にすることもできます。 最後に選んだリポジトリは記憶されます。

  1. GitHub で、リポジトリのメイン ページに移動します。

  2. リポジトリ名の下にある [イシュー] をクリックします。

    リポジトリのメイン ページのスクリーンショット。 水平ナビゲーション バーでは、[イシュー] というラベルが付いたタブが濃いオレンジ色の枠線で囲まれています。

  3. Issue の一覧から、Pull Request またはブランチをリンクする Issue をクリックします。

  4. 右側のサイドバーで、 [開発] をクリックします。

    issue サイドバーのスクリーンショット。 [開発] が濃いオレンジ色の枠線で囲まれています。

  5. Issue にリンクする Pull Request またはブランチを含むリポジトリをクリックします。

  6. Issue にリンクする Pull Request またはブランチをクリックします。

  7. [適用] をクリックします。

参考資料