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

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

应用场景

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

前提准备

  • 已授权使用代码检查服务。
  • 通用Git代码仓中已有Java语言的代码。

操作流程

表1 操作流程

序号

步骤

说明

1

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

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

2

新建通用Git服务扩展点

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

3

创建通用Git代码检查任务

创建代码检查任务。

4

执行通用Git代码检查任务

执行代码检查任务。

5

查看代码检查结果

查看代码检查结果。

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

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

新建通用Git服务扩展点

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

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

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

    表2 新建通用Git服务扩展点

    参数

    说明

    连接名称

    自定义,支持中文、英文、数字、“-”、“_”、“.”、空格,不超过256个字符。例如:Endpoint01。

    Git仓库Url

    输入待连接的Git仓库的https地址。

    用户名

    输入待连接的Git仓库的用户名,不超过300个字符。

    密码或Access Token

    输入待连接的Git仓库的密码,不超过300个字符。

创建通用Git代码检查任务

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

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

    参数

    说明

    归属项目

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

    代码源

    选择“通用Git”

    任务名称

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

    Endpoint实例

    选择新建通用Git服务扩展点中创建的服务扩展点“Endpoint01”

    仓库

    保持默认即可。

    分支

    保持默认“master”即可。

    检查语言

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

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

执行通用Git代码检查任务

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

查看代码检查结果

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

    至此,我们完成了一次基本的通用Git代码源常用检查流程。