创建代码检查任务
代码检查服务可检查不同代码仓的代码质量,在创建代码检查任务前,需满足以下条件:
- 已新建CodeArts项目。
- 如果使用的是代码托管服务(CodeArts Repo)的代码仓库,则可以参考代码托管服务的新建代码仓库。 ,完成
- 如果使用的是第三方代码仓库,需已创建可用的代码仓库。
创建Repo代码源检查任务
在代码托管中创建云端仓库时,若勾选了“自动创建代码检查任务”,则代码仓库创建完成后,在代码检查任务列表可查看对应仓库的检查任务。
以下示例为在代码托管服务中创建云端仓库不勾选“自动创建代码检查任务”时,Repo代码源代码检查任务的创建步骤。
- 基于项目入口访问CodeArts Check服务首页。
- 在代码检查页面,单击“新建任务”,在“新建任务”页面,参考表1配置参数后单击“新建任务”。
表1 Repo代码源检查任务参数说明 参数名称
参数说明
是否必填
归属项目
任务所属项目。
- 以项目入口方式访问CodeArts Check服务时默认填写,无需手动填写。
- 以服务入口访问时需根据实际情况选择新建项目中创建的项目。
是
代码源
选择Repo,检查代码托管服务中的代码质量。
是
任务名称
代码检查任务名称,可自定义。
- 支持中英文,数字,点,下划线“_”和连接符“-”。
- 字符长度范围为1~128。
是
仓库
选择需要检查的代码仓库。
是
分支
选择需要检查的仓库分支。
是
检查语言
选择需要检查的代码语言。
否
- 创建代码检查任务后,如果您需要修改任务名称或默认分支,可在“代码检查详情”页面,选择“设置 > 基本信息”,修改任务名称和默认分支。
- 对于不再继续使用的代码检查任务,可进入“代码检查详情”页面,选择“设置 > 基本信息”,删除当前代码检查任务。也可以单击代码检查任务所在行,在下拉框中,选择“删除”。
若删除的代码检查任务其代码仓为多分支代码仓,分支数量小于200时可删除成功,大于等于200会删除失败。
创建GitHub代码源检查任务
创建GitHub代码源检查任务前,需将Github仓库设置成公开。
- 使用第三方代码仓库可能出现网络不稳定或其他问题,具体使用体验取决于第三方代码仓库网络环境和服务状态。
- 建议使用代码托管的代码导入功能,将代码导入到代码托管,实现安全、稳定、高效下载与构建。
- 基于项目入口访问CodeArts Check服务首页。
- 在代码检查页面,单击“新建任务”,在“新建任务”页面,参考表2配置参数后单击“新建任务”。
表2 GitHub代码源检查任务参数说明 参数项
说明
是否必填
归属项目
任务所属项目。
- 以项目入口方式访问CodeArts Check服务时默认填写,无需手动填写。
- 以服务入口访问时需根据实际情况选择新建项目中创建的项目。
是
代码源
选择GitHub,检查托管在GitHub代码仓中的代码质量。
是
任务名称
代码检查任务名称,可自定义。
- 支持中英文,数字,点,下划线“_”和连接符“-”。
- 字符长度范围为1~128。
是
Endpoint实例
选择连接到GitHub代码仓库的服务扩展点。如果没有,可参考新建服务扩展点中“新建GitHub服务扩展点”创建。
是
Repository
选择需要检查的代码仓库。
是
Branch
选择需要检查的仓库分支。
是
检查语言
选择需要检查的代码语言。
否
- 创建代码检查任务后,如果您需要修改任务名称或默认分支,可在“代码检查详情”页面,选择“设置 > 基本信息”,修改任务名称和默认分支。
- 对于不再继续使用的代码检查任务,可进入“代码检查详情”页面,选择“设置 > 基本信息”,删除当前代码检查任务。也可以单击代码检查任务所在行,在下拉框中,选择“删除”。
若删除的代码检查任务其代码仓为多分支代码仓,分支数量小于200时可删除成功,大于等于200会删除失败。
创建GitCode代码源检查任务
- 基于项目入口访问CodeArts Check服务首页。
- 在代码检查页面,单击“新建任务”,在“新建任务”页面,参考表3配置参数后单击“新建任务”。
表3 GitCode代码源检查任务参数说明 参数项
说明
是否必填
归属项目
任务所属项目。
- 以项目入口方式访问CodeArts Check服务时默认填写,无需手动填写。
- 以服务入口访问时需根据实际情况选择新建项目中创建的项目。
是
代码源
选择GitCode,检查托管在GitCode代码仓中的代码质量。
是
任务名称
代码检查任务名称,可自定义。
- 支持中英文,数字,点,下划线“_”和连接符“-”。
- 字符长度范围为1~128。
是
Endpoint实例
选择连接到GitCode代码仓库的服务扩展点。如果没有,可参考新建服务扩展点中“新建GitCode服务扩展点”创建。
是
仓库
选择需要检查的代码仓库。
是
分支
选择需要检查的仓库分支。
是
检查语言
选择需要检查的代码语言。
否
- 创建代码检查任务后,如果您需要修改任务名称或默认分支,可在“代码检查详情”页面,选择“设置 > 基本信息”,修改任务名称和默认分支。
- 对于不再继续使用的代码检查任务,可进入“代码检查详情”页面,选择“设置 > 基本信息”,删除当前代码检查任务。也可以单击代码检查任务所在行,在下拉框中,选择“删除”。
若删除的代码检查任务其代码仓为多分支代码仓,分支数量小于200时可删除成功,大于等于200会删除失败。
创建通用Git代码源检查任务
- 基于项目入口访问CodeArts Check服务首页。
- 在代码检查页面,单击“新建任务”,在“新建任务”页面,参考表4配置参数后单击“新建任务”。
表4 通用Git代码源检查任务参数说明 参数项
描述
是否必填
归属项目
任务所属项目。
- 以项目入口方式访问CodeArts Check服务时默认填写,无需手动填写。
- 以服务入口访问时需根据实际情况选择新建项目中创建的项目。
是
代码源
选择通用Git。对于托管在其他服务上的代码,可以使用通用Git连接实现代码拉取。
是
任务名称
代码检查任务名称,可自定义。
- 支持中英文,数字,点,下划线“_”和连接符“-”。
- 字符长度范围为1~128。
是
Endpoint实例
选择连接到通用Git代码仓库的服务扩展点。如果没有,可参考#codecheck_ug_0000/section5999559152718中“新建通用Git服务扩展点”创建。
是
仓库
选择需要检查的代码仓库。
是
分支
输入需要检查的仓库分支。
是
检查语言
选择需要检查的代码语言。
否
- 创建代码检查任务后,如果您需要修改任务名称或默认分支,可在“代码检查详情”页面,选择“设置 > 基本信息”,修改任务名称和默认分支。
- 对于不再继续使用的代码检查任务,可进入“代码检查详情”页面,选择“设置 > 基本信息”,删除当前代码检查任务。也可以单击代码检查任务所在行,在下拉框中,选择“删除”。
若删除的代码检查任务其代码仓为多分支代码仓,分支数量小于200时可删除成功,大于等于200会删除失败。
创建码云代码源检查任务
- 基于项目入口访问CodeArts Check服务首页。
- 在代码检查页面,单击“新建任务”,在“新建任务”页面,参考表5配置参数后单击“新建任务”。
表5 码云代码源检查任务参数说明 参数项
说明
是否必填
归属项目
任务所属项目。
- 以项目入口方式访问CodeArts Check服务时默认填写,无需手动填写。
- 以服务入口访问时需根据实际情况选择新建项目中创建的项目。
是
代码源
选择码云,检查托管在码云代码仓中的代码质量。
是
任务名称
代码检查任务名称,可自定义。
- 支持中英文,数字,点,下划线“_”和连接符“-”。
- 字符长度范围为1~128。
是
Endpoint实例
选择连接到码云代码仓库的服务扩展点。如果没有,可参考新建服务扩展点中“新建码云服务扩展点”创建。
是
Repository
选择需要检查的代码仓库。
是
Branch
选择需要检查的仓库分支。
是
检查语言
选择需要检查的代码语言。
否
- 创建代码检查任务后,如果您需要修改任务名称或默认分支,可在“代码检查详情”页面,选择“设置 > 基本信息”,修改任务名称和默认分支。
- 对于不再继续使用的代码检查任务,可进入“代码检查详情”页面,选择“设置 > 基本信息”,删除当前代码检查任务。也可以单击代码检查任务所在行,在下拉框中,选择“删除”。
若删除的代码检查任务其代码仓为多分支代码仓,分支数量小于200时可删除成功,大于等于200会删除失败。