建议更改

  • 引入于 11.6 版本
  • 建议的自定义提交消息引入于 13.9 版本,在功能标志后默认禁用。
  • 功能标志移除于 13.10 版本。

作为审核者,您可以在合并请求差异主题中使用 Markdown 语法建议代码更改。然后,合并请求作者(或具有适当权限的其他用户)能够通过单击应用这些建议,在建议更改的用户创作的合并请求中生成提交。

  1. 选择要更改的一行代码,添加新注释,然后选择工具栏中的 插入建议 图标:

    Add a new comment

  2. 在评论中,将您的建议添加到预先填充的代码块中:

    Add a suggestion into a code block tagged properly

  3. 选择 启动评审添加到评审 将您的评论添加到审核,或选择 立即添加评论 立即将评论添加到主题。

    评论中的建议可以由合并请求作者直接从合并请求中应用:

    Apply suggestions

  4. (可选)为单个建议(13.9 及更高版本)指定自定义提交消息以描述您的更改。如果未指定,则使用默认提交消息。

    Custom commit

作者应用了一个建议后,它被标记为 已应用 标签,主题自动解决,系统创建一个新的提交,并将建议的更改直接推送到合并请求分支中的代码库中。开发人员角色需要这样做。

多行建议

审核者还可以通过调整范围偏移量在合并请求差异主题中,使用单个建议对多行提出更改建议。偏移量与 diff 主题的位置相关,并指定在应用建议时要替换的范围。

Multi-line suggestion syntax

在前面的示例中,建议涵盖注释行上方三行和下方四行。应用后,它将用建议的更改替换注释行的 上方 3 行到 下方 4 行。

Multi-line suggestion preview

note对多行的建议限制为 100 行 上方 和 100 行 下方 注释差异行。允许每个建议最多更改 200 行。

嵌套在建议中的代码块

如果您需要提出涉及代码块的建议,请将您的建议用四个反引号包裹起来,而不是通常的三个。

A comment editor with a suggestion with a fenced code block

Output of a comment with a suggestion with a fenced code block

为应用的建议配置提交消息

极狐GitLab 在应用建议时使用默认提交消息:Apply %{suggestions_count} 建议到 %{files_count} 文件

例如,假设用户将 3 个建议应用于 2 个不同的文件,默认提交消息是:将 3 个建议应用于 2 个文件

可以自定义这些提交消息以遵循您可能拥有的任何准则。 为此,请展开项目 通用 设置中的 合并请求 选项卡并更改 合并推荐 文本:

Custom commit message for applied suggestions

除了静态文本,您还可以使用以下变量:

变量 描述 输出示例
%{branch_name} 建议所应用的分支的名称。 my-feature-branch
%{files_count} 已应用建议的文件数。 2
%{file_paths} 已应用文件建议的路径。 路径用逗号分隔。 docs/index.md, docs/about.md
%{project_path} 项目路径。 my-group/my-project
%{project_name} 项目的人类可读名称。 My Project
%{suggestions_count} 已应用的建议数。 3
%{username} 应用建议的用户的用户名。 user_1
%{user_full_name} 应用建议的用户的全名。 User 1

例如,要自定义提交消息以输出 Addresses user_1’s review,请将自定义文本设置为 Addresses %{username}'s review

对于从派生项目创建的合并请求,极狐GitLab 使用目标项目中定义的模板。

批量建议

  • 引入于 13.1 版本作为 alpha 功能,在功能标志后默认禁用
  • 于 13.2 版本默认启用。
  • 功能标志移除于 13.11 版本。
  • 自定义提交消息的批处理建议引入于 14.4 版本。

您可以一次应用多个建议,以减少添加到您的分支的提交数量,以满足您的审核者的请求。

  1. 要开始通过单个提交应用一批建议,请选择 将建议加入批量处理

    A code change suggestion displayed, with the button to add the suggestion to a batch highlighted.

  2. 根据需要向批次添加尽可能多的其他建议:

    A code change suggestion displayed, with the button to add an additional suggestion to a batch highlighted.

  3. 要删除建议,请选择 从批处理中移除

    A code change suggestion displayed, with the button to remove that suggestion from its batch highlighted.

  4. 根据您的喜好添加所有建议后,准备就绪后,选择应用建议。您可以选择批量建议(14.4 及更高版本)指定自定义提交消息来描述您的更改。如果未指定,则使用默认提交消息。

    A code change suggestion displayed, with the button to apply the batch of suggestions highlighted.

caution从多个作者应用的建议会创建由应用建议的用户创作的提交。