DataWorks提供代码评审功能,开启强制代码评审开关后,开发人员提交的节点必须通过评审人对代码的审核才可以发布。

前提条件

代码评审限DataWorks专业版及以上版本使用。标准模式的工作空间支持开发者自主选择代码评审或由管理员开启强制代码评审,简单模式的工作空间仅支持开发者自主选择代码评审。

使用限制

DataWorks的简单模式工作空间不支持代码评审功能,该功能只适用于标准模式的工作空间。

开启强制代码评审

  1. 进入数据开发页面。
    1. 登录DataWorks控制台
    2. 在左侧导航栏,单击工作空间列表
    3. 选择工作空间所在地域后,单击相应工作空间后的进入数据开发
  2. 单击左下方的设置图标,在右侧展开设置页面。
  3. 设置页面,单击工作空间配置
  4. 代码评审配置区域,打开启用强制代码评审开关,并指定强制代码评审基线范围
    代码评审配置
    代码评审的基线范围包括1级基线任务3级基线任务5级基线任务7级基线任务8级基线任务非基线任务,其相关说明如下:
    • 任务的数值越大优先级越高,基线任务的优先级高于非基线任务。配置基线任务的优先级,详情请参见基线管理
    • 指定强制代码评审基线范围指定了对应级别的基线任务,该级别的任务在发起评审后,必须由评审人员对任务代码审核通过才可进行发布。
    • 多个任务并发启动运行时,高优先级的任务会优先抢占资源,此时,如果您对高级别的任务指定了指定强制代码评审基线范围,则评审人员可以对任务的代码质量进行把控,防止由于任务代码有误,未经审核直接发布后报错,长时间占用资源。

代码评审流程

  1. 在节点或业务流程的编辑页面,单击工具栏中的提交图标。
  2. 提交新版本对话框中,输入变更描述指定代码评审人
    提交新版本
    说明
    • 循环、遍历等组合型节点不支持发起代码评审。
    • 指定代码评审人后,会生成代码评审单。
    • 如果工作空间未启用强制代码评审,代码评审为可选。如果工作空间启用强制代码评审,则代码评审为必选,且评审不通过会阻断任务的发布。
  3. 单击确认
  4. 发起评审后,您可以单击左上方的提交图标,选择全部 > 代码评审,进入代码评审页面。代码评审
  5. 代码评审页面,审核人可以评审代码,提交人可以查看发起的评审。
    审核人可以进行评论通过不通过废弃重开等操作。开启强制评审后,审核人的评审结果会影响节点的发布。其中通过操作会触发代码审核检查器检查通过,不通过废弃操作会拦截提交人发布节点。您可以在代码审核详情页面对比提交版本和生产版本的代码。
    操作 描述
    评论 对当前版本进行评论。
    通过 通过当前版本的评审。
    不通过 不通过当前版本的评审。
    说明 如果工作空间未开启启用强制代码评审,不通过评审仍可以发布。如果工作空间已开启启用强制代码评审,不通过评审会阻塞发布。
    废弃 废弃当前版本的评审。
    重开 废弃后,您可以在我审核的 > 废弃页面,重开本次评审。
    代码评审页面包括我审核的我发起的
    • 我审核的:您可以查看自己审核的所有评审记录。我审核的
      单击相应记录后的查看,您可以对评审请求进行评论通过不通过废弃重开等操作。操作
    • 我发起的:您可以查看自己提交的所有评审记录。我发起的