GithubのPRからissueの関連付けとcloseする方法!

この記事では、GithubのPRからissueを関連付け、自動で閉じる方法を説明しています。GithubではPRとissueを関連付けることができます。これにより、作業の状況をわかりやすくする、自動でissueを閉じる、などの利点があります。

コンテンツ [表示]

  1. 1GithubのPRとissueを関連付ける
  2. 1.1GithubでissueとPRを手動で関連付ける
  3. 1.2GithubでissueとPRをキーワードで関連付ける
  4. 2GithubのPRからissueをcloseする

GithubのPRとissueを関連付ける

Githubでは、issuesとプルリクエストを関連付けることで、問題に対してどの程度作業が進んでいるのかなどをわかりやすくする事ができます。
また、この作業をすることでプルリクエストをマージしたときに自動でissueを閉じる事ができます。

GithubでissueとPRを手動で関連付ける

issueと関連付けたいプルリクエストの画面を開きます。
右側のサイドバーを見ていくと、「Linked issues」という項目があります。
ここをクリックすると、関連付けたいissueを選択することができます

PR画面

最大で10個のisuueを各プルリクエストに手動でリンクできます。ただしissueと関連付けられるプルリクエストは同じリポジトリにあるものだけになります。

GithubでissueとPRをキーワードで関連付ける

プルリクエストの説明文もしくはコミットメッセージに定められたキーワードを書くことで、プルリクエストとissuesを自動で関連付けることができます。

PR画面

使うことができるキーワードは

  • close
  • closes
  • closed
  • fix
  • fixes
  • fixed
  • resolve
  • resolves
  • resolved
の9つです。
このキーワードの後ろに、#issuesの番号を加えて結びつけます。

書き方の例

Closes #10

違うリポジトリにあるissuesと関連付けたい場合は、もう少し記述を増やす必要があります。
違うリポジトリにあるissuesと関連付ける場合にはキーワード 所有者/リポジトリ問題番号と記述します。

書き方の例

Closes suzuki/my-repo#10

また、複数のissuesと関連付けたい場合には、上記の記述を「,」で区切って並べて書きます。

書き方の例

Resolves #10, resolves #123, resolves suzuki/my-repo#100

GithubのPRからissueをcloseする

上記の方法でissuesとプルリクエストを結びつけると、プルリクエストをマージしたときにissuesも自動でcloseされます!

作業が完了してマージすると同時にissueを閉じることができるので閉じ忘れがなくなったり、作業の効率が上がりますね。

是非試してみてください!

Qumeru[クメル]ではプログラミング学習が出来るカリキュラムを7月31日までの期間限定で無料で提供しています。

無料登録することで、すぐにプログラミング学習を始められます。ぜひカリキュラムをお試し下さい!

関連記事

【期間限定】全カリキュラム無料で提供中!

Qumeru[クメル]ではプログラミング学習の全カリキュラムを7月31日まで期間限定で無料で提供しています。

無料登録することで、すぐにプログラミング学習を始められます。ぜひお試し下さい!

目次

まゆ
ライター

まゆ

 主にHTML,Bootstrapの記事を描いています。