GitHubでcommitにissueを紐付ける

GitHubで使えるちょっと便利な小技のメモ

関連するissueへのリンクを自動で貼る

commitメッセージに#issue番号とすることで自動的にそのissueへのリンクを貼ってくれます。

git commit -m "#1 commit message"

上記の例では、1番のIssue へリンクされます。

関連するissueを自動的にcloseする

プルリクエストやコミットにキーワードと Issue 番号を入れると、そのプルリクエストと Issue とが関連付けられます。
プルリクエストがリポジトリのデフォルトブランチにマージされると、対応する Issue が自動的にクローズされます。

以下のキーワードの後に Issue 番号を入れると、その Issue がクローズされます。

  • close
  • closes
  • closed
  • fix
  • fixes
  • fixed
  • resolve
  • resolves
  • resolved

たとえば、プルリクエストの説明またはコミットメッセージに "Closes #123""Closes: #123" と記入すれば、番号 123 の Issue をクローズできます。
ブランチがデフォルトブランチにマージされると、Issue がクローズされます。 複数のIssueをクローズしたい場合は、 "Closes #123 Closes #124"