创建代码检查任务
创建代码检查任务是指用户通过代码检查工具,为特定的代码源(如 CodeArts Repo、GitHub、GitCode 等代码仓库)创建专项任务,以自动扫描和检测代码质量。通过自动化工具或平台,发现代码中的潜在错误、安全漏洞、性能问题和代码风格不一致等问题,保障代码质量和项目稳定性。本章节为用户介绍如何单个创建或批量创建不同代码源的代码检查任务。
前提条件
- 已新建CodeArts项目。
- 若使用的是代码托管服务(CodeArts Repo)的代码仓库,则可以参考代码托管服务的,完成新建代码仓库。
- 如果使用的是第三方代码仓库,需已创建可用的代码仓库。
约束与限制
创建Repo代码源检查任务
- 在CodeArts Repo服务中创建云端仓库时,若勾选了“自动创建代码检查任务”,系统将根据仓库中包含的编程语言自动创建相应的代码检查任务,并默认启用相应的规则集。代码仓库创建完成后,在代码检查任务列表可查看对应仓库的检查任务。
注意事项:
自定义规则集:用户可以在创建任务后,手动调整或自定义规则集。
多语言支持:系统支持多种编程语言的混合仓库,会为每种语言分别创建检查任务。
- 以下示例为在CodeArts Repo服务中创建云端仓库不勾选“自动创建代码检查任务”时,Repo代码源代码检查任务的创建步骤。
- 访问CodeArts Check服务首页。
- 在代码检查页面,单击“新建任务”,在“新建任务”页面,参考表1配置参数。
表1 Repo代码源检查任务参数说明 参数
说明
所属项目
任务所属项目。
- 以项目入口方式访问CodeArts Check服务时默认填写,无需手动填写。
- 以服务入口访问时需根据实际情况选择新建项目中创建的项目。
新建方式
选择创建代码检查任务的模板。创建单个代码检查任务时,选择“空模板”。
代码源
选择检查的代码源。
任务名称
代码检查任务名称,可自定义。
- 支持中英文,数字,点,下划线“_”和连接符“-”。
- 字符长度范围为3~128。
代码仓
选择需要检查的代码仓库。
默认分支
选择需要检查的仓库分支。
检查语言
选择需要检查的代码语言。当前支持检查的语言可参考支持主流开发语言。
当代码源是Repo时,检查语言会根据代码仓默认选择,只能减少语言,不能手动新增语言。
- 单击“确定”,完成代码检查任务创建。可在代码检查任务列表页查看到该任务。
- 创建代码检查任务后,如果需要修改任务名称、分组或默认分支,可在“代码检查详情”页面,选择“设置 > 基本信息”,修改任务名称、分组和默认分支。
- 对于不再继续使用的代码检查任务,可进入“代码检查详情”页面,选择“设置 > 基本信息”,删除当前代码检查任务。也可以单击代码检查任务所在行
,在下拉框中,选择“删除”。
若删除的代码检查任务其代码仓为多分支代码仓,分支数量小于200时可删除成功,大于等于200会删除失败。
注意:此操作会删除当前任务下所有数据,且不可恢复!
- 单击任务所在行右侧的
,在下拉框中选择“复制”跳转至代码检查详情的“设置”界面,支持设置任务信息和执行该代码检查任务。
创建第三方代码仓的代码检查任务
- 使用第三方代码仓库可能出现网络不稳定或其他问题,具体使用体验取决于第三方代码仓库网络环境和服务状态。
- 建议使用代码托管的代码导入功能,将代码导入到代码托管,实现安全、稳定、高效下载与构建。
- 访问CodeArts Check服务首页。
- 在代码检查页面,单击“新建任务”,在“新建任务”页面,参考表2配置参数。
表2 第三方代码源检查任务参数说明 参数
说明
所属项目
任务所属项目。
- 以项目入口方式访问CodeArts Check服务时默认填写,无需手动填写。
- 以服务入口访问时需根据实际情况选择新建项目中创建的项目。
新建方式
选择创建代码检查任务的模板。创建单个代码检查任务时,选择“空模板”。
代码源
选择检查的代码来源。
- 选择通用“Git”。对于托管在其他服务上的代码,可以使用通用Git连接实现代码拉取。
任务名称
代码检查任务名称,可自定义。
- 支持中英文,数字,点,下划线“_”和连接符“-”。
- 字符长度范围为1~128。
服务扩展点
选择连接到第三方代码仓库的服务扩展点。如果没有,可参考新建服务扩展点创建对应代码仓的服务扩展点。
代码仓
选择需要检查的代码仓库。
默认分支
选择需要检查的仓库分支。
检查语言
选择需要检查的代码语言。当前支持检查的语言可参考支持主流开发语言。
- 单击“确定”,代码检查任务创建完成。可在代码检查任务列表页查看到该任务。
- 创建代码检查任务后,如果需要修改任务名称、分组或默认分支,可在“代码检查详情”页面,选择“设置 > 基本信息”,修改任务名称、分组和默认分支。
- 对于不再继续使用的代码检查任务,可进入“代码检查详情”页面,选择“设置 > 基本信息”,删除当前代码检查任务。也可以单击代码检查任务所在行
,在下拉框中,选择“删除”。
若删除的代码检查任务其代码仓为多分支代码仓,分支数量小于200时可删除成功,大于等于200会删除失败。
注意:此操作会删除当前任务下所有数据,且不可恢复!
- 单击任务所在行右侧的
,在下拉框中选择“复制”跳转至代码检查详情的“设置”界面,支持设置任务信息和执行该代码检查任务。