# 创建代码检查任务 创建代码检查任务是指用户通过代码检查工具，为特定的代码源（如 CodeArts Repo、GitHub、GitCode 等代码仓库）创建专项任务，以自动扫描和检测代码质量。通过自动化工具或平台，发现代码中的潜在错误、安全漏洞、性能问题和代码风格不一致等问题，保障代码质量和项目稳定性。本章节为用户介绍如何单个创建或批量创建不同代码源的代码检查任务。 [创建单个Repo代码源检查任务] [创建单个第三方代码仓的代码检查任务] [批量创建代码检查任务] [自定义代码检查任务模板] #### 前提条件 - 已[新建CodeArts项目](https://support.huaweicloud.com/usermanual-devcloud/codearts_01_0027.html)。 - 若使用的是代码托管服务（CodeArts Repo）的代码仓库，则可以参考代码托管服务的"用户指南 \> 新建Repo代码仓库"，完成[新建代码仓库](https://support.huaweicloud.com/usermanual-codeartsrepo/codeartsrepo_03_0017.html)。 - 如果使用的是第三方代码仓库，需已创建可用的代码仓库。 #### 约束与限制 - 若删除的代码检查任务其代码仓为多分支代码仓，分支数量小于200时可删除成功，大于等于200会删除失败。 **注意：**此操作会删除当前任务下所有数据，且不可恢复！ - 仅通过项目/租户模板的创建方式，支持批量创建代码检查任务。单次最多可以创建10个代码检查任务。 - 使用第三方代码仓库可能出现网络不稳定或其他问题，具体使用体验取决于第三方代码仓库网络环境和服务状态。 #### 创建单个Repo代码源检查任务 - 在CodeArts Repo服务中创建云端仓库时，若勾选了"自动创建代码检查任务"，系统将根据仓库中包含的编程语言自动创建相应的代码检查任务，并默认启用相应的规则集。代码仓库创建完成后，在代码检查任务列表可查看对应仓库的检查任务。 **注意事项**： **自定义规则集**：用户可以在创建任务后，手动调整或自定义规则集。 **多语言支持**：系统支持多种编程语言的混合仓库，会为每种语言分别创建检查任务。 - 以下示例为在CodeArts Repo服务中创建云端仓库不勾选"自动创建代码检查任务"时，Repo代码源代码检查任务的创建步骤。 1. [访问CodeArts Check服务首页](https://support.huaweicloud.com/usermanual-codecheck/devcloud_hlp_00101.html#devcloud_hlp_00101__section125631532175013)。 2. 在代码检查页面，单击"新建任务"，在"新建任务"页面，参考[表1]配置参数。 表1Repo代码源检查任务参数说明 | **参数** | **说明** | |:---|:---| | 所属项目 | 任务所属项目。 - 以项目入口方式访问CodeArts Check服务时默认填写，无需手动填写。 - 以服务入口访问时需根据实际情况选择[新建项目](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0000.html)中创建的项目。 | | 新建方式 | 选择创建代码检查任务的模板。创建单个代码检查任务时，选择"空模板"。 | | 代码源 | 选择检查的代码源。 - Repo：检查当前项目下Repo代码仓中的代码质量。 在代码仓和其子模块为同一种开发语言时，支持对子模块进行检查。 - 其他项目Repo：检查其他项目下Repo代码仓的代码质量。 | | 任务名称 | 代码检查任务名称，可自定义。 - 支持中英文，数字，点，下划线"_"和连接符"-"。 - 字符长度范围为3\~128。 | | 项目 | 当"代码源"选择"其他项目Repo"时，选择Repo代码仓所在的项目。 | | 代码仓 | 选择需要检查的代码仓库。 | | 默认分支 | 选择需要检查的仓库分支。 | | 检查语言 | 选择需要检查的代码语言。当前支持检查的语言可参考[支持主流开发语言](https://support.huaweicloud.com/productdesc-codecheck/codeartscheck_07_1005.html)。 当代码源是Repo时，检查语言会根据代码仓默认选择，只能减少语言，不能手动新增语言。 | 3. 单击"确定"，完成代码检查任务创建。可在代码检查任务列表页查看到该任务。 - 创建代码检查任务后，如果需要修改任务名称、分组或默认分支，可在"代码检查详情"页面，选择"设置 \> 基本信息"，修改任务名称、分组和默认分支。 - 对于不再继续使用的代码检查任务，可进入"代码检查详情"页面，选择"设置 \> 基本信息"，删除当前代码检查任务。也可以单击代码检查任务所在行![](https://support.huaweicloud.com/usermanual-codecheck/zh-cn_image_0000002332851210.png)，在下拉框中，选择"删除"。 若删除的代码检查任务其代码仓为多分支代码仓，分支数量小于200时可删除成功，大于等于200会删除失败。 **注意：**此操作会删除当前任务下所有数据，且不可恢复！ - 单击任务所在行右侧的![](https://support.huaweicloud.com/usermanual-codecheck/zh-cn_image_0000002509388267.png)，在下拉框中选择"复制"跳转至代码检查详情的"设置"界面，支持设置任务信息和执行该代码检查任务。 #### 创建单个第三方代码仓的代码检查任务 - 使用第三方代码仓库可能出现网络不稳定或其他问题，具体使用体验取决于第三方代码仓库网络环境和服务状态。 - 建议使用代码托管的代码导入功能，将代码导入到代码托管，实现安全、稳定、高效下载与构建。 1. [访问CodeArts Check服务首页](https://support.huaweicloud.com/usermanual-codecheck/devcloud_hlp_00101.html#devcloud_hlp_00101__section125631532175013)。 2. 在代码检查页面，单击"新建任务"，在"新建任务"页面，参考[表2]配置参数。 表2第三方代码源检查任务参数说明 | **参数** | **说明** | |:---|:---| | 所属项目 | 任务所属项目。 - 以项目入口方式访问CodeArts Check服务时默认填写，无需手动填写。 - 以服务入口访问时需根据实际情况选择[新建项目](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0000.html)中创建的项目。 | | 新建方式 | 选择创建代码检查任务的模板。创建单个代码检查任务时，选择"空模板"。 | | 代码源 | 选择检查的代码来源。 - 选择"**GitHub** "，检查托管在GitHub代码仓中的代码质量。 创建GitHub代码源检查任务前，需将Github仓库设置成公开。 - 选择"**GitCode**"，检查托管在GitCode代码仓中的代码质量。 - 选择通用"**Git**"。对于托管在其他服务上的代码，可以使用通用Git连接实现代码拉取。 - 选择"**码云**"，检查托管在码云代码仓中的代码质量。 | | 任务名称 | 代码检查任务名称，可自定义。 - 支持中英文，数字，点，下划线"_"和连接符"-"。 - 字符长度范围为1\~128。 | | 服务扩展点 | 选择连接到第三方代码仓库的服务扩展点。如果没有，可参考[新建服务扩展点](https://support.huaweicloud.com/usermanual-devcloud/devcloud_01_0019.html)创建对应代码仓的服务扩展点**。** | | 代码仓 | 选择需要检查的代码仓库。 | | 默认分支 | 选择需要检查的仓库分支。 | | 检查语言 | 选择需要检查的代码语言。当前支持检查的语言可参考[支持主流开发语言](https://support.huaweicloud.com/productdesc-codecheck/codeartscheck_07_1005.html)。 | 3. 单击"确定"，代码检查任务创建完成。可在代码检查任务列表页查看到该任务。 - 创建代码检查任务后，如果需要修改任务名称、分组或默认分支，可在"代码检查详情"页面，选择"设置 \> 基本信息"，修改任务名称、分组和默认分支。 - 对于不再继续使用的代码检查任务，可进入"代码检查详情"页面，选择"设置 \> 基本信息"，删除当前代码检查任务。也可以单击代码检查任务所在行![](https://support.huaweicloud.com/usermanual-codecheck/zh-cn_image_0000002332851210.png)，在下拉框中，选择"删除"。 若删除的代码检查任务其代码仓为多分支代码仓，分支数量小于200时可删除成功，大于等于200会删除失败。 **注意：**此操作会删除当前任务下所有数据，且不可恢复！ - 单击任务所在行右侧的![](https://support.huaweicloud.com/usermanual-codecheck/zh-cn_image_0000002509388267.png)，在下拉框中选择"复制"跳转至代码检查详情的"设置"界面，支持设置任务信息和执行该代码检查任务。 #### 批量创建代码检查任务 仅自定义模板的创建方式，支持批量创建代码检查任务。单次最多可以创建10个代码检查任务。 1. [访问CodeArts Check服务首页](https://support.huaweicloud.com/usermanual-codecheck/devcloud_hlp_00101.html#devcloud_hlp_00101__section125631532175013) 2. 在代码检查页面，单击"新建任务"，在"新建任务"页面，参考[表3]配置参数。 表3批量任务参数说明 | **参数** | **说明** | |:---|:---| | 所属项目 | 需要使用的模板所属项目。 - 以项目入口方式访问CodeArts Check服务时默认填写，无需手动填写。 - 以服务入口访问时需根据实际情况选择[新建项目](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0000.html)中创建的项目。 | | 新建方式 | 选择使用的模板，可选择"项目模板"或"租户模板"。 - **项目模板**：使用当前项目下自定义的任务模板。 - **租户模板**：使用当前租户自定义的任务模板。 **租户模板和项目模板的差异如下：** - [通知管理](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_0007.html)：基于租户模板创建任务不继承接受者角色、自定义成员配置信息。 - [检查范围](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_0022.html)：基于租户模板创建任务不继承忽略文件的配置信息。 - [自定义环境](https://support.huaweicloud.com/usermanual-codecheck/codeartscheck_01_7033.html)：基于租户模板创建任务不继承私有依赖仓扩展点信息。 - 租户模板不支持修改模板信息。 | | 模板 | 选择对应的自定义模板。若无模板，可参考[自定义代码检查任务模板](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0000.html#codecheck_ug_0000__section922553716268)新建模板。 | | 代码源 | 选择检查的代码来源。 - 选择"**Repo**"，检查托管在Repo代码仓中的代码质量。 - 选择"**GitHub** "，检查托管在GitHub代码仓中的代码质量。 创建GitHub代码源检查任务前，需将Github仓库设置成公开。 - 选择"**GitCode**"，检查托管在GitCode代码仓中的代码质量。 - 选择"**通用Git**"。对于托管在其他服务上的代码，可以使用通用Git连接实现代码拉取。 - 选择"**码云**"，检查托管在码云代码仓中的代码质量。 | | 任务信息 | - **项目：**选择代码检查任务的所属项目。 - **服务扩展点：** 代码源选择非Repo代码仓时需要配置。如果没有服务扩展点，可参考[新建服务扩展点](https://support.huaweicloud.com/usermanual-devcloud/devcloud_01_0019.html)创建对应代码仓的服务扩展点**。** - **代码仓**：选择代码检查任务使用的代码仓。 - **默认分支**：选择代码检查任务需要检查的仓库分支。 - **任务名称：**填写代码检查任务的名称。支持中英文，数字，点，下划线"_"和连接符"-"，字符长度范围为3\~128。 单击"增加任务"，可创建新的代码检查任务，单次最多可创建10个代码检查任务。 | 3. 单击"确定"，批量代码检查任务创建完成。 可在对应项目下的代码检查任务列表中查看到新建的代码检查任务。 #### 自定义代码检查任务模板 1. [访问CodeArts Check服务首页](https://support.huaweicloud.com/usermanual-codecheck/devcloud_hlp_00101.html#devcloud_hlp_00101__section125631532175013)。 2. 在代码检查任务列表页，选择" 配置中心 \> 模板管理"。 3. 单击"新建模板"，在弹出的窗口按照参数配置。 表4模板参数说明 | **参数** | **说明** | |:---|:---| | 所属项目 | 任务所属项目。 - 以项目入口方式访问CodeArts Check服务时默认填写，无需手动填写。 - 以服务入口访问时需根据实际情况选择[新建项目](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0000.html)中创建的项目。 | | 代码源 | - 选择"**GitHub** "，检查托管在GitHub代码仓中的代码质量。 创建GitHub代码源检查任务前，需将Github仓库设置成公开。 - 选择"**GitCode**"，检查托管在GitCode代码仓中的代码质量。 - 选择"**通用Git**"。对于托管在其他服务上的代码，可以使用通用Git连接实现代码拉取。 - 选择"**码云**"，检查托管在码云代码仓中的代码质量。 - 选择"**Repo**"，检查托管在Repo代码仓中的代码质量。 | | 模板名称 | 代码检查任务名称，可自定义。 - 支持中英文，数字，点，下划线"_"和连接符"-"。 - 字符长度范围为3\~128。 | | 服务扩展点 | 选择连接到第三方代码仓库的服务扩展点。如果没有，可参考[新建服务扩展点](https://support.huaweicloud.com/usermanual-devcloud/devcloud_01_0019.html)创建对应代码仓的服务扩展点**。** | | 代码仓 | 选择需要检查的代码仓库。 | | 默认分支 | 选择需要检查的仓库分支。 | 4. 单击"确定"，代码检查任务模板创建完成。 可在代码检查任务模板列表中查看到该模板，并且在基于租户模板或者项目模板新建代码检查任务时可以选到该模板。 #### 管理代码检查任务 CodeArts Check支持批量管理代码检查任务，除"导出任务告警"外，其他批量管理操作仅项目内支持该功能。 1. 在代码检查任务列表页，勾选任务名称前的复选框。 2. 在弹出的窗口中可对选中的任务进行移动分组，[修改配置]，删除和[导出任务]的操作。 - "修改配置"支持修改[规则集](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0001.html)，[质量门禁](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_1004.html)，[定时执行](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_0005.html)，[MR检查模式](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_0022.html#codecheck_01_0022__section1334320161918)，[检查目录](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_0022.html)，[自定义镜像](https://support.huaweicloud.com/usermanual-codecheck/codeartscheck_01_7033.html#codeartscheck_01_7033__section19648741617)，[配置私有依赖仓扩展点](https://support.huaweicloud.com/usermanual-codecheck/codeartscheck_01_7033.html#codeartscheck_01_7033__section9934713182115)，[检查前置命令](https://support.huaweicloud.com/usermanual-codecheck/codeartscheck_01_7033.html#codeartscheck_01_7033__section151342062213)，[新问题起始时间](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0003.html#codecheck_ug_0003__section9269173613814)，[源文件编码](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0003.html#codecheck_ug_0003__section18211731152911)，[问题责任人精准匹配](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0003.html#codecheck_ug_0003__section6641164023417)，[消息通知](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_0007.html#codecheck_01_0007__section1690811011912)。 - 任务移动分组，导出任务告警，批量修改配置和批量删除任务均最多支持50个代码检查任务。 **单个任务导出：** 1. 单击"代码问题"页签。 2. 选择"全量操作 \> 全量导出"，可将代码检查问题信息导出至本地。 **批量任务导出：** **注意：**处于导出中的任务不可重复执行导出动作，否则可能会导出失败。 ![](https://support.huaweicloud.com/usermanual-codecheck/zh-cn_image_0000002533815547.png "点击放大") 1. 返回至代码检查任务列表页，勾选代码检查任务名称前的复选框，可选择的任务数为1\~50，单个任务的问题数不可超过20万。 2. 在页面下方弹框中单击"导出任务告警"。 3. 在弹窗口的下拉框中选择需要导出的选项，单击"开始导出"。 4. 单击"查看下载"，即可查看导出进度。 5. 待导出完成后，单击"下载"，可将代码检查问题信息导出至本地。 图1批量管理代码检查任务 ![](https://support.huaweicloud.com/usermanual-codecheck/zh-cn_image_0000002493927328.png "点击放大") ![](https://support.huaweicloud.com/usermanual-codecheck/zh-cn_image_0000002526086993.png "点击放大") 导出的任务告警里的检查引擎默认不显示，如果需要查看参考[配置代码检查显示引擎](https://support.huaweicloud.com/usermanual-codecheck/codecheck_ug_0109.html)，打开引擎开关后再导出任务告警。 #### 相关文档 - 创建代码检查任务相关API接口可参考[新建检查任务](https://support.huaweicloud.com/api-codecheck/CreateTaskV3.html)。 - 任务管理的相关API接口可参考[任务管理](https://support.huaweicloud.com/api-codecheck/topic_300000000.html)。 - 使用代码检查服务的相关最佳实践可参考[代码检查最佳实践](https://support.huaweicloud.com/bestpractice-codecheck/codeartscheck_14_0000.html)。 - 后续操作可参考[配置代码检查任务](https://support.huaweicloud.com/usermanual-codecheck/codecheck_01_0001.html)。