文档首页/ 代码检查 CodeArts Check/ 最佳实践/ 使用预置规则检查GitCode代码仓中的代码质量
更新时间:2024-10-25 GMT+08:00
分享

使用预置规则检查GitCode代码仓中的代码质量

应用场景

如果您的代码存放在GitCode代码仓中,可参考本实践的操作指导完成检查代码质量。本实践为您介绍如何使用系统预置规则检查GitCode代码仓中的Java语言代码质量。

前提准备

操作流程

表1 操作流程

序号

步骤

说明

1

创建代码检查任务所属项目

创建代码检查任务所属的项目。

2

新建GitCode服务扩展点

本实践检查第三方代码仓的代码质量,CodeArts Check服务需通过CodeArts提供的扩展插件连接到第三方代码仓。

3

新建GitCode代码检查任务

创建代码检查任务。

4

执行GitCode代码检查任务

执行代码检查任务。

5

查看GitCode代码检查详情

查看代码检查结果。

创建代码检查任务所属项目

  1. 使用华为云账号登录华为云控制台页面
  2. 单击页面左上角,在服务列表中选择开发与运维 > 软件开发生产线 CodeArts
  3. 单击“立即使用”,进入CodeArts服务首页。
  4. 在首页单击“新建项目”,选用“Scrum”项目模板。项目名称填写“Scrum01”,其他参数保持默认即可。
  5. 单击“确定”后,进入到“Scrum01”项目下。

新建GitCode服务扩展点

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

代码检查服务默认检查CodeArts Repo服务的代码质量,同时也可使用服务扩展点连接第三方代码仓库检查代码质量。

  1. 在项目下的CodeArts Check服务页面的导航栏选择设置 > 通用设置 > 服务扩展点管理
  2. 单击“新建服务扩展点”,在下拉列表中选择“GitCode”
  3. 参考表2在弹框中配置参数。

    表2 GitCode服务扩展点参数说明

    参数

    说明

    连接名称

    服务扩展点的名称,可自定义。例如:GitCode。

    Token

    填写GitCode上获取的Token,获取方法如下:

    1. 登录GitCode
    2. 单击页面右上角账号名称,选择“个人设置”
    3. 单击 “+访问令牌”,填写令牌名称以及到期时间。
    4. 单击“新建访问令牌”,生成“你的个人访问令牌”,即Token。
    5. 单击,即可复制生成的Token。
      说明:
      • Token生成后,请及时保存,下次刷新页面将无法读取,需要重新生成新Token。
      • 注意填写有效的Token描述信息,避免误删除导致构建失败。
      • 无需使用时,请及时删除Token,避免信息泄露。

  4. 单击“确定”

新建GitCode代码检查任务

  1. 选择导航栏代码 > 代码检查
  2. 单击“新建任务”,进入新建任务页面,配置如下参数。

    表3 GitCode代码检查任务参数说明

    参数

    说明

    归属项目

    任务所属项目。默认填写为创建代码检查任务所属项目中的项目名称“Scrum01”,无需手动填写。

    代码源

    选择需要检查的代码来源。选择“GitCode”

    任务名称

    代码检查任务名称,可自定义。例如:GitCodeCheckTask。。

    Endpoint实例

    选择新建GitCode服务扩展点中创建的服务扩展点“GitCode”

    仓库

    选择需要检查的代码仓库,保持默认即可。

    分支

    选择需要检查的仓库分支,保持默认即可。

    检查语言

    选择需要检查的代码语言,选择“Java”

  3. 单击“新建任务”,完成检查任务的创建。

执行GitCode代码检查任务

  1. 在代码检查页面任务列表中,单击“GitCodeCheckTask”代码检查任务所在行
  2. 根据页面提示等待任务执行完成。

查看GitCode代码检查详情

  1. 在代码检查页面任务列表中,搜索新建GitCode代码检查任务创建的任务名称。
  2. 单击任务名称,查看代码检查详情,包括概览、代码问题、代码度量、检查日志等。

相关文档