讨论
您可以在以下位置发表评论:
- Issues
- Epics
- 合并要求
- 代码片
- 提交
- diff
除了标准的评论形式外,您还可以选择以话题讨论的方式创建评论, 收到回复后,评论也将是话题讨论的形式。
评论区域支持Markdown和快速操作 , 您可以随时编辑自己的评论,拥有" maintainer"或更高权限的用户也可以编辑其他人的评论。
您还可以通过回复评论通知电子邮件来回复评论,回复标准评论会创建另一个标准评论。回复主题评论会在主题中创建回复,电子邮件回复支持Markdown和快速操作。
注意: 每个对象最多只能有 5,000 条评论,例如:issue,epic 及合并请求。
可解决的评论及讨论
讨论有助于跟踪计划和代码审查的进度。
合并请求,提交,提交差异和代码片中的每个评论或讨论初始状态都显示为未解决,具有Developer及以上权限的任何人或所检查的更改的作者都可以单独解决这些问题。即使该讨论已解决,如果非成员没有解决他们自己的响应,讨论也不会标记为解决;如果非成员解决了相同的答复,则讨论会被标记为已解决。
解决所有评论或讨论可以防止您忘记处理反馈,并可以隐藏不再相关的线程。
在合并请求的上下文中发起讨论
对于具有基于提交的工作流的审阅者,在合并请求的上下文中将讨论添加到特定的提交差异上可能很有用。 在以下情况下,这些讨论将通过提交ID更改来保持不变:
- Rebase后强行提交代码
- 修改提交的评论
可以按照以下步骤创建提交差异讨论:
-
导航到合并请求的提交选项卡,将显示构成合并请求的提交列表
-
进入选定的提交,单击更改选项卡(在该选项卡中,将仅显示与所选提交不同的内容),并提交评论
-
以这种方式创建的任何讨论都将显示在合并请求的讨论选项卡中,并且可以解决
以这种方式创建的线程将仅出现在原始合并请求中,而不是在项目的代码">"提交页面下的提交中。
提示: 在合并请求内的讨论中引用的提交的链接时,它将在当前合并请求的上下文中自动转换为链接。
解决话题跳转
当合并请求中包含大量评论时,可能很难跟踪未解决的评论。 您可以使用讨论上"回复"字段旁边的"跳转"按钮在未解决的讨论之间快速跳转。
您还可以使用快捷键在讨论之间导航:
- 使用
n
跳到下一个未解决的线程. - 使用
p
跳到上一个未解决的线程.
将评论或讨论标记为已解决
您可以通过单击讨论底部的解决讨论按钮将其标记为已解决。
或者,您可以将每个评论单独标记为已解决。
在合并请求中所有未解决讨论转为 Issue
要在新 Issue 中解决当前自合并请求中的所有未解决的讨论时,可以单击再新问题中解决所有讨论的按钮。
或者,当您的项目仅在解决所有讨论后才接受合并请求时 ,在合并请求部件中会有一个创建一个新 Issue 以便稍后解决的选项。
将单个讨论转变成 Issue
要从单个讨论创建新 Issue时,可以使用在新问题中解决此讨论按钮。
您将会跳转到预填充了讨论内容的新 Issue,类似于为一次委派多个讨论而创建的 Issue。创建 Issue 将把该讨论标记为已解决,并在合并请求讨论中添加引用新 Issue 的评论。
只有全部讨论内容解决后才允许合并
在解决所有讨论之前,将不允许合并合并请求。
要使该设置生效,需要进入项目的设置页面,选中仅在解决所有讨论后才允许合并请求复选框,然后单击保存即可。
从现在开始,直到所有讨论解决后,您才能从网页上进行合并操作。
Automatically resolve merge request diff threads when they become outdated
在 GitLab 10.0 中引入 .
您可以在使用新的推送修改的行上自动解决合并请求差异线程.
导航到您的项目的设置页面,选中使用推送更改的行上的自动解析合并请求差异线程复选框,然后单击保存以使更改生效.
从现在开始,如果推送使 diff 部分过时,默认情况下将解决 diff 上的所有线程. 不变的线上线程和顶级可解析线程不会自动解析.
提交的讨论
您可以在项目的代码> 提交下向特定提交添加评论和讨论。
注意: 如果在强制推送后更改了提交 ID,则以这种方式创建的讨论将丢失。
讨论的讨论
虽然可解决的讨论仅适用于合并请求的文件diff,但也可以添加与文件diff无关的讨论, 您可以针对 Issue,提交,摘要及合并请求添加一个看起来像讨论的特定讨论。
要开始讨论,请单击评论按钮切换下拉列表,选择开始讨论,并在准备发布评论时单击开始讨论 按钮。
这将以单个讨论的形式发起评论,使您可以更大的范围进行特定的讨论。
图片的讨论
有时讨论会围绕图片展开。使用图片讨论,您可以轻松地定位图像的特定坐标并在其周围开启讨论。图片讨论在合并请求详情和提交的详情页面中可用。
要启动图片讨论,请将鼠标悬停在图片上。当您的鼠标指针转换为图标时,表示该图片可用于讨论,此时只需单击图片上的任意位置以创建新的讨论即可。
单击图片后,将显示新建评论输入框,保存评论后,您会在图像顶部看到一个新的徽章,此徽章代表您的讨论。
锁定讨论
对于有较多贡献者参与的大型项目,在以下场景中禁用讨论将会非常地有帮助:
- 项目维护者已经解决了该问题,无需更多的后续反馈
- 项目维护者已经将新讨论指向了新的 Issue 或合并请求
- 参与讨论者的讨论内容比较随意、辱骂或是无益的产品建议
在这些情况下,项目中具有开发者权限或更高权限的用户可以使用边栏中的"锁定"按钮来锁定/解锁 问题或合并请求. 对于问题,具有记者权限的用户可以锁定/解锁。
在锁定的问题或合并请求中,只有团队成员才能添加新评论和编辑现有评论,非团队成员无法添加或编辑评论。
合并请求评审
查看"合并请求"差异时,您可以开始审阅,您可以在"合并请求"中创建仅在发布之前才对您可见的评论,以便您可以将所有评论作为单个操作提交。
开始评审
为了开始审阅,只需像往常一样在合并请求的更改选项卡下对差异添加评论,然后单击开始审阅按钮。
当开始审阅后,审阅内容部分中所有的评论都会被标记为Pending
,同时所有审阅中的评论都会显示两个按钮:
- 完成审阅 :提交审阅中的所有评论,使其他用户可以看到它们
- 立即添加评论 :提交常规评论,而不是审阅的一部分
您可以在评论中使用快速操作 ,评论也将会显示提交评论后即将执行的操作。
要向评论添加更多评论,请照常开始写评论,然后单击添加到评论按钮,这会将评论添加到评论中。
建议更改
作为审阅者,您可以在合并请求的 diff 讨论中通过简单的 Markdown 语法来实现建议的代码修改。合并请求作者(或具有适当权限的其他用户)能够单击应用这些建议,同时将在合并请求中生成一个由接受并应用建议的用户产生的提交。
- 找到你想要建议修改的代码,单击并添加一个新的评论,然后单击工具栏上的插入建议按钮:
- 在评论中,在预设好的代码块中添加上你的修改建议:
- 单击
启动评审
或立即添加评论
按钮将你的修改建议添加到评论中。在合并请求中,你的修改建议可以直接被合并请求的作者直接应用:
一旦作者接受了某个修改建议,它将会被标记为已应用
,同时这个讨论也会被自动标记为已解决
,系统也会将建议的修改直接提交给合并请求的源分支(注意:至少需要开发者权限才可以进行这个操作)。
多行的修改建议
通过调整修改范围,审阅者还可以在合并请求 diff 中通过一个建议对多行进行修改。这个修改范围的偏移相对于 diff 的位置,并指定应用建议时要替换的范围。
在上面的例子中,建议修改的范围包括插入评论的上面四行和下面三行以。当该建议更改被接受后,以插入修改建议的 28 行为基准,会将其上方的四行和下方的三行按照建议的修改进行修改。
注意:合并请求 diff 中的多行修改建议限制在插入评论的上方100行和下方100行,即允许每个修改建议最多更改200行代码。
修改建议中的代码块
如果修改建议中包含代码块,则需要将包裹修改建议的3个反引号`改为4个。
自定义修改建议的提交消息
在应用建议时使用默认的提交消息,其格式为:将 %{Suggestions_count}建议应用到 %{files_count}文件。例如,假设一个用户对2个不同的文件应用了3个建议,默认提交消息将是:对2个文件应用3个建议。
这些提交消息可以按照您的要求进行定制。如果需要定制,请在项目的常规设置中展开“合并请求”选项卡,然后更改“合并建议”文本:
除静态文本外,还支持使用以下变量:
变量 | 说明 | 输出示例 |
---|---|---|
%{branch_name} | 应用了建议的分支名称 | my-feature-branch |
%{files_count} | 应用了建议的文件数量 | 2 |
%{file_paths} | 应用了建议的文件路径,多个文件会用逗号分隔开 | docs/index.md, docs/about.md |
%{project_path} | 当前项目路径 | my-group/my-project |
%{project_name} | 项目名称(可阅读) | 我的项目 |
%{suggestions_count} | 应用了的建议数量 | 3 |
%{username} | 应用建议的用户id | lish |
%{user_full_name} | 应用建议的用户昵称 | 李老师 |
比如,如果想要将提交信息定制为 “处理了李老师的代码审查”,可以将该提交信息设置为 '处理了 %{username} 的代码审查'
批量应用建议
你可以一次应用多个建议,以减少分支中按照你的代码审核人员建议修改后的提交次数。
可以通过单击“将建议加入批量处理”按钮来开启批量应用建议,多个建议被应用后只会产生一次提交。你可以按照你的需要多次添加修改建议;如果要从批量建议中移除某个建议,则单击“从批量中移除”按钮。当添加好全部需要应用的建议后,单击“应用建议(建议数量)”即可。