Yak shaving logs


My life is just yak shaving.

Githubのkeywordを利用してPull Requestがマージ、クローズされたタイミングで関連するIssueも同時に閉じる

2017/08/04 #github #tips

By Yusuke Takita


こんにちは。Takitaです。

プルリクをマージしたり、クローズした後にいちいち関連するIssueをクローズしたりするのは面倒です。GitHubではkeywordという予約語があり、その予約語のあとにIssueの番号を書くとプルリクがマージ、クローズされたタイミングでIssueもクローズしてくれます。

おすすめはプルリクのテンプレにkeywordを入れておく方法です。
[GitHub] IssueとPull Requestのテンプレート機能を利用してフォーマットを統一する

プルリクの内容の書き方

fixes #1 のようにkeywordとIssueの番号をセットで記載します。

https://gyazo.com/8d73e266e62b93ea1f3cd2cde08e9f83

https://gyazo.com/0698f5b2e3e3da1947bccfbea17ec72d

keywords

以下の単語がkeywordとして使えます。

This pull request fixes #1 の省略形の fixes #1 が自然かなあと思ってぼくは fixes を使うようにしました。(resolvesでもいいのですが、文字数が少し長い・・・w)

close
closes
closed
fix
fixes
fixed
resolve
resolves
resolved

コミットメッセージにキーワードを入れてIssueをクローズする方法もある

$ git commit -m "Fix screwup, fixes #12" のようにkeywordとIssue番号を入れると同じことができます。

ひとつのプルリクで複数のissueをクローズしたい場合

This closes #34, closes #23, and closes example_user/example_repo#42 という感じで keyword #issue_no と複数記載します。

参考

https://help.github.com/articles/closing-issues-using-keywords/
https://help.github.com/articles/closing-issues-using-keywords/#closing-multiple-issues
https://github.com/tiimgreen/github-cheat-sheet#closing-issues-via-commit-messages


2017/08/30
「ひとつのプルリクで複数のissueをクローズしたい場合」を追記しました。

このエントリーをはてなブックマークに追加

categories


最新記事


tags