Ruby, Rails, Git再入門 GitHubのIssuesをcloseするコミットメッセージ

photo credit: WilliamMarlow via photopin cc

GitHubを使っていて、ふと以前RedmineとSVNで開発していた頃にチケット(Issue)にコミットメッセージから関連付けたり(refs)、クローズ(fixes)をしていたことを思い出した。そこでGitHubだとどういったキーワードで関連付けできるのか調べたので、記載する。

チケット(Issue)をクローズさせるコミットメッセージ

チケット(Issue)をクローズする際のキーワード

キーワードは以下の通り。

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

クローズするチケット(Issue)の指定方法

同じリポジトリのチケット(Issue)を指定する場合は、#1と書くことで、チケット(Issue)#1をクローズできる。

異なるリポジトリのチケット(Issue)を指定する場合は、username/repository#issue_numberと書くことで、チケット(Issue)#1をクローズできる。

チケット(Issue)をクローズする方法

close #1とコミットメッセージに書く。

ちなみに最近知ったのだが、#はナンバーサインで、番号を示す番号の前に置かれる記号とのこと。No.を使うのが一般的だと思っていたので、これを知って驚いた。

参考資料