皆様こんにちは。SEの小池と申します。
今回のブログでは、GitLabのコメントテンプレート について述べます。
コメントテンプレートはその名の通り、マージリクエスト等のコメント欄のテンプレートを作成できる機能です。 日々GitLabで開発業務に従事している方の負担をちょっとだけ軽減できる (かもしれない) 機能なので、是非ご利用ください。
本記事の対象の方
- GitLab 16.0 の新規機能の一つであるコメントテンプレートについて、情報を収集中の方。
- GitLabでコメントを効率的に入力する方法を模索していらっしゃる方。
今回のブログのゴール
このブログのゴールはこちらです。
- コメントテンプレートの概要を把握する。
- 実際にGitLabでコメントテンプレートを作成し、使用してみる。
事前ご連絡事項
- 本記事はSaaS版 (GitLab.com) の Enterprise Edition 16.1.0-pre における仕様をベースに記載しております。それ以外のエディションやバージョンではこの記事に記載の通りではない可能性がございます。
- 本記事の操作説明と画面ショットはGitLabのローカライズを日本語にした状態で説明しております。それ以外の言語をご利用の方は適宜読み替えてください。
- 本記事に掲載されている情報は正確性・安全性を保証するものではありません。本記事の情報を利用することによって発生した損失や損害については、一切の責任を負いかねます。
コメントテンプレートとは？
コメントテンプレートは、マージリクエスト、イシュー、エピックなどへコメントを入力する際に、事前に定義したテンプレートを使用することができる機能です。
この機能はGitLab 16.0で導入され、SaaS版 および Self-Managed版の全ての価格帯（無償版も含む）で利用可能です。
参考 : Comment templates | GitLab
コメントテンプレートはユーザー設定として保存されるので、開発者一人一人が自分にとって使い勝手の良いテンプレートを作成・保存することができます。
また、作ったコメントテンプレートは、マージリクエスト、イシュー、エピック等のコメント欄で横断的に使用することができます。コメントテンプレートを作る
実際にコメントテンプレートを作成してみましょう。
GitLabのGUIに、ご自身のアカウントでサインインします。
サインイン後、左上 (※) にある自分のアイコンをクリックし [プロファイルを編集] もしくは [設定] をクリックします。
※ バージョンによっては右上にあります。
左側のメニューで [コメントテンプレート] をクリックします。
コメントテンプレート作成画面が表示されるので、名前とコンテンツ (コメントテンプレートの中身) を設定します。今回はマージリクエストで使うことを念頭に置いて、以下のようなテンプレートを作成してみました。
(コメントテンプレートはMarkdown書式をサポートしています。)
ご確認いただきありがとうございます。 ご指摘いただきました下記の事項を修正致しました。 ### ご指摘事項 【要変更】ここに指摘された事項を書く。 ### 修正方針 【要変更】修正方針を書く。 ### 修正箇所 【要変更】修正箇所を書く。 お忙しいところ恐れ入りますが、再度ご確認いただけますでしょうか。 よろしくお願い致します。
[保存] をクリックします。
マイコメントテンプレートの一覧に、作成したコメントテンプレートが表示されていることを確認します。
続けて別のコメントテンプレートを作成したい場合は、この画面で続けて作成が可能です。
コメントテンプレートの作成方法は以上です。
次は、実際に作ったコメントテンプレートを使用してみます。
コメントテンプレートを使う
作ったコメントテンプレートを使用してみましょう。
このブログでは例としてマージリクエストのコメント欄でコメントテンプレートを使用しますが、同じ手順でイシューやエピックのコメント欄でも使用することができます。
コメントテンプレートを作成したアカウントで、GitLabのGUIにサインインします。
サインイン後、任意のプロジェクトのページを開き、任意のマージリクエストの詳細画面を開きます。
コメント記入欄の上部、一番右の吹き出しアイコンをクリックすると、先ほど作成したコメントテンプレートがプルダウンで表示されます。
利用したいコメントテンプレート名をクリックします。
すると・・・先ほど作成したコメントテンプレートがコメント欄に反映されます！すごい便利！！
あとは微修正しつつ、メンションを付けてコメントを投稿するだけで・・・
見た目がいい感じのコメントを手間なく投稿できました。
コメントテンプレートの使用方法は以上です。
このブログではマージリクエストのテンプレート欄を使って試しましたが、イシューやエピックのコメント欄でも同様にコメントテンプレートを使用できます。
最後に
この度はGitもCI/CDもよくわかっていないど素人SEによるGitLab検証ブログをお読みいただき、誠にありがとうございます。
このブログの目標は以下のとおりでしたが、皆さまはいかがでしたでしょうか。
- コメントテンプレートの概要を把握する。
- 実際にGitLabでコメントテンプレートを作成し、使用してみる。
コメントテンプレートは、本当にシンプルな便利機能です。
機能理解のために勉強する必要もなく、ただただ開発者ライクな便利機能です。
逆になぜ今までなかったのか不思議・・・。
無償版でも利用可能なシンプル 且つ 便利というメリットしかない機能なので、GitLabで開発をなさっている方は是非ご利用をご検討いただければと存じます。
この記事がGitLabを触り始めた方の一助となれば幸いにございます。
GitLabに関するお問い合わせは、以下のフォームからお願い致します。
GitLab製品 お問い合わせ
今までのGitLabの検証ブログはこちらです。
GitLab操作デモ動画 (基本編) を作ってみました。(音声の録音は自宅でiPhoneのボイスメモ使うという超低クオリティですが…。)
つたない内容ではありますが、ご興味がおありでしたら是非ご視聴いただければと存じます。
