typememo.jp

Gitlab イシューテンプレートの作り方 – 何でも自動化したい精神

2020.10.27

#tech#git#gitlab#template
Takeru Yamada

Contents


はじめに

Gitlab のイシューテンプレート並びにマージリクエストテンプレートの設定方法についての紹介です.

イシューやマージリクエストに記載する内容を共通化しておくと便利です.

Gitlab は無料でテンプレート設定機能が実装されていますので,使った方が良いです.

本記事ではテンプレートの設定方法を手短に紹介します.

それでは参りましょう!

参考:

  • Description templates
    本記事は Description templates を抜粋して日本語に意訳したものです. 英語を読むのに苦手意識がなければ本家を読むのが一番です.
  • GitLab実践ガイド
    書籍で Gitlab のことをマルッと知りたい方はこちらがおすすめです.

.gitlab ディレクトリを作成する

まずは .gitlab という名前のディレクトリを作成してください. 作成する場所はリポジトリのトップディレクトリがおすすめです.

$ mkdir .gitlab

.gitlab/issue_templates/Hogehoge.md を作成する

.gitlab ディレクトリ内に issue_templates という名前のディレクトリを作成してください.

続いて issus_templates ディレクトリ内にテンプレートファイル (.md) を作成します. このテンプレートファイルの名前が Gitlab の WebUI で表示される名前になります. なので Bug.md とか QnA.md などの名前でテンプレートファイルを作成すると良いと思います.

次の具体例では Hogehoge.md という名前のテンプレートファイルを作成しています.

$ mkdir .gitlab/issue_templates
$ touch .gitlab/issue_templates/Hogehoge.md

テンプレートファイルの中身はお好きにどうぞ! 良いテンプレートの例は バグチケット テンプレート とかググれば出てきますので, 気に入ったものを参考にしてテンプレートファイルの中身を埋めると良いと思います.

筆者の場合は次のコマンドで Article.md というイシューテンプレートを作成しました.

$ code .gitlab/issue_templates/Article.md

.gitlab/merge_request_templates/Hugahuga.md を作成する

イシューテンプレートと同様の手順でマージリクエストのテンプレートも作成できます.

.gitlab ディレクトリ内に merge_request_templates ディレクトリを作成して, その中にテンプレートファイル (.md) を作成すれば良いです. 例えば,次の具体例のように.

$ mkdir .gitlab/merge_request_templates
$ touch .gitlab/merge_request_templates/Hugahuga.md

Issue または Merge Request 作成時に Choose a template でテンプレートを選択する

イシューやマージリクエストのテンプレートファイルをリポジトリのメインブランチに push しましたか?

もしも push していればイシューやマージリクエストを作成するときに Choose a template で作成したテンプレートが選択可能になっていると思います.

Gitlab Choose a template

この画像ではご自身のテンプレートは表示されていませんが,メインブランチにテンプレートファイルを push している状態であればテンプレートが選択可能になっていますのでご安心を.

デフォルトテンプレート設定は Starter と Bronze 以上なら定義可能

2020.10.27 時点の情報ですがデフォルトテンプレートの設定は Starter もしくは Bronze 以上のユーザーなら設定可能だそうです.

おわりに

Gitlab のイシューテンプレート並びにマージリクエストテンプレートの設定方法についての紹介でした.

簡単にできそうだから使ってみよう

と思っていただけたら嬉しいです.

そして実際に使ってみてくれたらもっと嬉しいです.

最後までお読みいただきありがとうございました.

山田武尊を応援していただけるととても嬉しいです!

愛用品

  • Xiser Pro Trainer
    1日中踏み続けられる強靭なステッパーでおすすめです.
  • HHKB Professional 墨 x HHKB キートップセット 白
    ボディは墨色キートップは白色なのでめちゃめちゃ目に優しいのでおすすめです.
  • Apple Magic Mouse 2
    トラックパッドは指が攣りそうになりますけどマウスはその心配が無いのでおすすめです.
  • Apple MacMini
    ミニマルでパワフルなデスクトップ PC なので個人的に大好きなのでおすすめです.
  • iiyama Display 27inch FullHD
    鮮明すぎない画面で目も疲れにくいですし何より高さ調節できるのが最高なのでおすすめです.
  • KINTO UNITEA 550ml
    500ml の大容量でこの綺麗なデザインは他にみたことがないのでおすすめです.