Help us learn about your current experience with the documentation. Take the survey.

提交信息模板

  • Tier: Free, Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

GitLab 使用提交信息模板为特定类型的提交创建默认信息。这些模板鼓励提交信息遵循特定格式，或包含特定信息。用户在合并合并请求时可以覆盖这些模板。

提交信息模板的语法类似于 审查建议 的语法。

即使没有配置模板，GitLab Duo 也可以帮助您生成合并提交信息。

配置提交信息模板

如果默认模板不包含您需要的信息，请更改您项目的提交信息模板。

先决条件：

  • 您必须至少拥有项目的 Maintainer 角色。

操作步骤：

  1. 在左侧边栏，选择 Search or go to 并找到您的项目。
  2. 选择 Settings > Merge requests。
  3. 根据您要创建的模板类型，滚动到 合并提交信息模板 或 压缩提交信息模板。
  4. 对于您想要的提交类型，输入您的默认信息。您可以使用静态文本和 变量。每个模板 限制为 500 个字符，但用数据替换模板后，最终信息可能会更长。
  5. 选择 Save changes。

合并提交的默认模板

合并提交信息的默认模板是：

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

%{title}

%{issues}

See merge request %{reference}

压缩提交的默认模板

如果您已将项目配置为在合并时压缩提交， GitLab 会使用此模板创建压缩提交信息：

%{title}

提交信息模板支持的变量

提交信息模板支持这些变量：

变量 描述 输出示例
%{source_branch} 要合并的分支名称。 my-feature-branch
%{target_branch} 应用更改的分支名称。 main
%{title} 合并请求的标题。 Fix tests and translations
%{issues} 包含短语 Closes <issue numbers> 的字符串。包含合并请求描述中提及的所有匹配问题关闭模式的问题。如果没有提及问题，则为空。 Closes #465, #190 and #400
%{description} 合并请求的描述。 Merge request description.
Can be multiline.
%{reference} 合并请求的引用。 group-name/project-name!72359
%{local_reference} 合并请求的本地引用。 !72359
%{source_project_id} 合并请求源项目的 ID。 123
%{first_commit} 合并请求差异中第一个提交的完整信息。 Update README.md
%{first_multiline_commit} 第一个不是合并提交且信息主体有多行的完整提交信息。如果所有提交都不是多行的，则为合并请求标题。 Update README.md

Improved project description in readme file.
%{first_multiline_commit_description} 第一个不是合并提交且信息主体有多行的提交的描述（不包括第一行/标题）。 Improved project description in readme file.
%{url} 合并请求的完整 URL。 https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1
%{reviewed_by} 合并请求审查者的换行列表，基于使用批量评论提交审查的用户，采用 Reviewed-by Git 提交尾注格式。 Reviewed-by: Sidney Jones <sjones@example.com>
Reviewed-by: Zhang Wei <zwei@example.com>
%{approved_by} 合并请求批准者的换行列表，采用 Approved-by Git 提交尾注格式。 Approved-by: Sidney Jones <sjones@example.com>
Approved-by: Zhang Wei <zwei@example.com>
%{merged_by} 合并合并请求的用户。 Alex Garcia <agarcia@example.com>
%{merge_request_author} 合并请求作者的姓名和邮箱。 Zane Doe <zdoe@example.com>
%{co_authored_by} Co-authored-by Git 提交尾注格式的提交作者姓名和邮箱。限制为合并请求中最近 100 个提交的作者。 Co-authored-by: Zane Doe <zdoe@example.com>
Co-authored-by: Blake Smith <bsmith@example.com>
%{all_commits} 合并请求中所有提交的信息。限制为最近 100 个提交。跳过超过 100 KiB 的提交主体和合并提交信息。 * Feature introduced

This commit implements feature
Changelog:added

* Bug fixed

* Documentation improved

This commit introduced better docs.

任何只包含空变量的行都会被删除。如果被删除的行前后都是空行，前面的空行也会被删除。

在打开的合并请求上编辑提交信息后，GitLab 会自动再次更新提交信息。 要将提交信息恢复为项目模板，请重新加载页面。

相关主题