コミットメッセージテンプレート

GitLabは、特定の種類のコミットのデフォルトメッセージを作成するためにコミットテンプレートを使用します。これらのテンプレートは、コミットメッセージが特定のフォーマットに従うこと、または特定の情報を含むことを奨励します。ユーザーは、マージリクエストをマージする際にこれらのテンプレートをオーバーライドできます。

コミットテンプレートの構文は、レビューの提案の構文に似ています。

GitLab Duoは、テンプレートを設定しなくてもマージコミットメッセージの生成に役立ちます。

コミットテンプレートを設定する

デフォルトのコミットテンプレートに必要な情報が含まれていない場合は、プロジェクトのコミットテンプレートを変更します。

前提条件:

• プロジェクトのメンテナーまたはオーナーロールを持っている必要があります。

これを行うには、次の手順を実行します:

1. 上部のバーで、検索または移動先を選択して、プロジェクトを見つけます。
2. 設定 > マージリクエストを選択します。
3. 作成したいテンプレートのタイプに応じて、マージコミットのメッセージテンプレートまたはスカッシュコミットのメッセージテンプレートのいずれかにスクロールしてください。
4. 希望するコミットタイプに、デフォルトメッセージを入力します。静的テキストと変数の両方を使用できます。各テンプレートは500文字に制限されていますが、データでテンプレートを置き換えた後、最終的なメッセージは長くなる可能性があります。
5. 変更を保存を選択します。

マージコミットのデフォルトテンプレート

マージコミットメッセージのデフォルトテンプレートは次のとおりです:

Merge branch '%{source_branch}' into '%{target_branch}'

%{title}

%{issues}

See merge request %{reference}

スカッシュコミットのデフォルトテンプレート

プロジェクトをコミットをスカッシュしてマージするように設定している場合、GitLabはこのテンプレートでスカッシュコミットメッセージを作成します:

%{title}

コミットテンプレートでサポートされている変数

コミットメッセージテンプレートは次の変数をサポートします:

空の変数のみを含む行は削除されます。削除された行の前後に空行がある場合、先行する空行も削除されます。

開いているマージリクエストでコミットメッセージを編集すると、GitLabはコミットメッセージを自動的に再度更新します。コミットメッセージをプロジェクトテンプレートに復元するには、ページを再読み込みします。

関連トピック

• スカッシュしてマージ。