連載
» 2017年04月28日 05時00分 UPDATE

こっそり始めるGit/GitHub超入門(12):開発者のスケジュール管理に超便利、GitHub Issues、Label、Milestone、Projects使いこなし術 (1/4)

本連載では、バージョン管理システム「Git」とGitのホスティングサービスの1つ「GitHub」を使うために必要な知識を基礎から解説しています。今回は、イシューとプルリクエストの連携やテンプレート設定、GitHub Projects、ラベル、マイルストーンなどを紹介します。

[平屋真吾,クラスメソッド]

GitHubのイシューやプルリクエストの周辺機能でスケジュール管理が容易に

 本連載「こっそり始めるGit/GitHub超入門」では、バージョン管理システムGit」とGitのホスティングサービスの1つ「GitHub」を使うために必要な知識を基礎から解説していきます。具体的な操作を交えながら解説していきますので、本連載を最後まで読み終える頃には、GitやGitHubの基本的な操作が身に付いた状態になっていると思います。

 前回の記事「開発者のタスク管理がしやすくなるGitHub Issuesの基本的な使い方」では「イシュー」に対する基本操作を解説しました。

 連載第12回目の本稿では、イシューとプルリクエストの連携やテンプレート設定、GitHub Projects、ラベル、マイルストーンなど、「イシューやプルリクエストの周辺機能」を解説していきます。

イシューとプルリクエストの連携

 まずは、プルリクエストがマージされたら関連するイシューを自動的にクローズする方法を紹介します。

 これを実現するには、以下の形式の文字列を「プルリクエストのコメント」または「プルリクエストに関連するコミット」のメッセージに含めます。

{キーワード} #{イシュー番号}

 GitHubのヘルプページの説明によると、以下の「キーワード」を使ってイシューを閉じることができます。

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

 「イシュー番号」はイシューのページなどで確認できます。

図1 イシューのページ上の「イシュー番号」

 例えば、イシュー番号3のイシューを閉じるには、以下の文字列をプルリクエストのコメントまたはコミットメッセージに含めます。

fix #3

 以下の例では、プルリクエストのコメントに文字列「fix #3」を入れています。

図2 プルリクエストのコメントに文字列「fix #3」を記載

 このプルリクエストをマージしてみます。

図3 マージ後のプルリクエストページ

 イシュー番号3のイシューを開くと、クローズされていることを確認できます。

図4 自動クローズ後のイシューのページ

イシューとプルリクエストのテンプレート設定

 イシューまたはプルリクエストのテンプレートを設定するには、以下の名前のファイルをリポジトリ直下(または.githubディレクトリ内)に配置します。

  • イシューのテンプレートの場合
    • ISSUE_TEMPLATE.md(拡張子は任意)
  • プルリクエストのテンプレートの場合
    • PULL_REQUEST_TEMPLATE.md (拡張子は任意)

 以下の例では、リポジトリ直下に「ISSUE_TEMPLATE.md」と「PULL_REQUEST_TEMPLATE.md」のファイルを配置しています。

図5 2つのファイルをリポジトリ直下に配置

 イシューを新規に作成すると「ISSUE_TEMPLATE.md」の内容が自動で挿入されます。

図6 新規作成イシューへのテンプレート自動挿入

 プルリクエストの場合も同様に、新規作成時に「PULL_REQUEST_TEMPLATE.md」の内容が自動で挿入されます。

図7 新規作成プルリクエストへのテンプレート自動挿入
       1|2|3|4 次のページへ

Copyright© 2017 ITmedia, Inc. All Rights Reserved.

@IT Special

- PR -

TechTargetジャパン

この記事に関連するホワイトペーパー

RSSについて

アイティメディアIDについて

メールマガジン登録

@ITのメールマガジンは、 もちろん、すべて無料です。ぜひメールマガジンをご購読ください。