更新时间:2024-10-10 GMT+08:00

创建代码检查任务

代码检查服务可检查不同代码仓的代码质量,在创建代码检查任务前,需满足以下条件:

  • 已新建CodeArts项目。
  • 如果使用的是代码托管服务(CodeArts Repo)的代码仓库,则可以参考代码托管服务的用户指南 > 新建Repo代码仓库,完成新建代码仓库
  • 如果使用的是第三方代码仓库,需已创建可用的代码仓库。

创建Repo代码源检查任务

在代码托管中创建云端仓库时,若勾选了“自动创建代码检查任务”,则代码仓库创建完成后,在代码检查任务列表可查看对应仓库的检查任务。

以下示例为在代码托管服务中创建云端仓库不勾选“自动创建代码检查任务”时,Repo代码源代码检查任务的创建步骤。

  1. 基于项目入口访问CodeArts Check服务首页
  2. 在代码检查页面,单击“新建任务”,在“新建任务”页面,参考表1配置参数后单击“新建任务”

    表1 Repo代码源检查任务参数说明

    参数名称

    参数说明

    是否必填

    归属项目

    任务所属项目。

    • 以项目入口方式访问CodeArts Check服务时默认填写,无需手动填写。
    • 以服务入口访问时需根据实际情况选择新建项目中创建的项目。

    代码源

    选择Repo,检查代码托管服务中的代码质量。

    任务名称

    代码检查任务名称,可自定义。

    • 支持中英文,数字,点,下划线“_”和连接符“-”
    • 字符长度范围为1~128。

    仓库

    选择需要检查的代码仓库。

    分支

    选择需要检查的仓库分支。

    检查语言

    选择需要检查的代码语言。

    • 创建代码检查任务后,如果您需要修改任务名称或默认分支,可在“代码检查详情”页面,选择“设置 > 基本信息”,修改任务名称和默认分支。
    • 对于不再继续使用的代码检查任务,可进入“代码检查详情”页面,选择“设置 > 基本信息”,删除当前代码检查任务。也可以单击代码检查任务所在行,在下拉框中,选择“删除”

      若删除的代码检查任务其代码仓为多分支代码仓,分支数量小于200时可删除成功,大于等于200会删除失败。

创建通用Git代码源检查任务

  1. 基于项目入口访问CodeArts Check服务首页
  2. 在代码检查页面,单击“新建任务”,在“新建任务”页面,参考表2配置参数后单击“新建任务”

    表2 通用Git代码源检查任务参数说明

    参数项

    描述

    是否必填

    归属项目

    任务所属项目。

    • 以项目入口方式访问CodeArts Check服务时默认填写,无需手动填写。
    • 以服务入口访问时需根据实际情况选择新建项目中创建的项目。

    代码源

    选择通用Git。对于托管在其他服务上的代码,可以使用通用Git连接实现代码拉取。

    任务名称

    代码检查任务名称,可自定义。

    • 支持中英文,数字,点,下划线“_”和连接符“-”
    • 字符长度范围为1~128。

    Endpoint实例

    选择连接到通用Git代码仓库的服务扩展点。如果没有,可参考新建服务扩展点“新建通用Git服务扩展点”创建

    仓库

    选择需要检查的代码仓库。

    分支

    输入需要检查的仓库分支。

    检查语言

    选择需要检查的代码语言。

    • 创建代码检查任务后,如果您需要修改任务名称或默认分支,可在“代码检查详情”页面,选择“设置 > 基本信息”,修改任务名称和默认分支。
    • 对于不再继续使用的代码检查任务,可进入“代码检查详情”页面,选择“设置 > 基本信息”,删除当前代码检查任务。也可以单击代码检查任务所在行,在下拉框中,选择“删除”

      若删除的代码检查任务其代码仓为多分支代码仓,分支数量小于200时可删除成功,大于等于200会删除失败。

新建服务扩展点

代码源选择第三仓库时需要配置。

服务扩展点(Endpoint)是软件开发生产线的一种扩展插件,为软件开发生产线提供链接第三方服务的能力。

CodeArts Check默认从代码托管服务拉取代码进行构建,同时也可使用服务扩展点连接第三方代码仓库获取项目源码。

  • 使用第三方代码仓库可能出现网络不稳定或其他问题,具体使用体验取决于第三方代码仓库网络环境和服务状态。
  • 建议使用代码托管的代码导入功能,将代码导入到代码托管,实现安全、稳定、高效下载与构建。

新建通用Git服务扩展点

  1. 单击“Endpoint实例”输入框中的,单击“新建扩展点”
  2. 在弹出的页面中,单击“新建服务扩展点”,选择“通用Git”
  3. 在弹出的对话框中,参考表3配置参数。
    表3 通用Git服务扩展点参数说明

    参数

    说明

    是否必填

    连接名称

    自定义连接名称。支持中文、英文、数字、“-”、“_”、“.”、空格,不超过256个字符。

    Git仓库Url

    填写用户实际使用的Git仓库的Url(https协议地址)。

    用户名

    填写用户实际使用的Git仓库用户名。

    密码或Access Token

    填写用户实际使用的Git仓库密码。

  4. 单击“确定”,返回创建代码检查任务页面。