Skip to main content

Pull RequestをIssueにリンクする

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

注釈: 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 は、既定のブランチに存在する 必要があります

  • 閉じる
  • closes
  • closed
  • 解決策
  • fixes
  • 固定
  • resolve
  • resolves
  • resolved

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

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

リンクするIssue構文
Issueが同じリポジトリにあるキーワード #issue 番号Closes #10
Issueが別のリポジトリにあるキーワード 所有者/リポジトリ#issue 番号Fixes 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. your GitHub Enterprise Server instance で、リポジトリのメイン ページへ移動します。 1. リポジトリ名の下にある [pull request] をクリックします。 [pull request] タブの選択

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

  3. 右のサイドバーで、"Development(開発)"セクション内でをクリックしてください。

  4. Pull RequestにリンクするIssueをクリックします。 issue をリンクするドロップダウン

参考資料