プルリクエストを課題にリンクする

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

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

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

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

メモ

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

キーワードを使ってプルリクエストを課題にリンクする

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

close
closes
closed
fix
fixes
fixed
resolve
resolves
resolved

別のプルリクエストでプルリクエストのコメントをキーワードで参照すると、プルリクエスト同士がリンクされます。参照元の pull request をマージすると、参照先の pull request もクローズされます。

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

リンクされた課題	構文	例
同じリポジトリにある問題	KEYWORD #ISSUE-NUMBER	`Closes #10`
Issueが別のリポジトリにある	KEYWORD OWNER/REPOSITORY#ISSUE-NUMBER	`Fixes octo-org/octo-repo#100`
複数の問題	各問題ごとに完全な構文を使用	`Resolves #10, resolves #123, resolves octo-org/octo-repo#100`

キーワードの後にコロンを付けることや、大文字にすることができます。例えば: Closes: #10、CLOSES #10、またはCLOSES: #10。

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

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

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

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

GitHub で、リポジトリのメインページに移動します。
リポジトリ名の下にある [Pull requests] をクリックします。
Pull Requestのリストで、IssueにリンクしたいPull Requestをクリックします。
右側のサイドバーで、 [開発] をクリックします。
Pull RequestにリンクしたいIssueをクリックしてください。

リポジトリへの書き込み権限がある任意のユーザーは、課題のサイドバーから手動でプルリクエストまたはブランチを課題にリンクできます。

手動で1つのPull Requestごとに最大10個のIssueをリンクできます。リンクされたプルリクエストまたはブランチとは異なるリポジトリに問題が存在する可能性があります。最後に選んだリポジトリは記憶されます。

GitHub で、リポジトリのメインページに移動します。
リポジトリ名の下にある [Issues] をクリックします。
Issue の一覧から、Pull Request またはブランチをリンクする Issue をクリックします。
右側のサイドバーで、 [開発] をクリックします。
Issue にリンクしたいプルリクエストまたはブランチを含むリポジトリをクリックしてください。
問題にリンクしたいプルリクエストまたはブランチをクリックします。

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

参考資料

        [AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls#issues-and-pull-requests)

プルリクエストを課題にリンクする

この記事で

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

キーワードを使ってプルリクエストを課題にリンクする

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

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

参考資料