• 沒有找到結果。

开通代码检查服务_代码检查 CodeCheck_用户指南_华为云

N/A
N/A
Protected

Academic year: 2022

Share "开通代码检查服务_代码检查 CodeCheck_用户指南_华为云"

Copied!
51
0
0

加載中.... (立即查看全文)

全文

(1)

用户指南

文档版本 23

发布日期 2021-05-27

(2)

版权所有 © 华为技术有限公司 2021。 保留一切权利。

非经本公司书面许可,任何单位和个人不得擅自摘抄、复制本文档内容的部分或全部,并不得以任何形式传 播。

商标声明

和其他华为商标均为华为技术有限公司的商标。

本文档提及的其他所有商标或注册商标,由各自的所有人拥有。

注意

您购买的产品、服务或特性等应受华为公司商业合同和条款的约束,本文档中描述的全部或部分产品、服务或 特性可能不在您的购买或使用范围之内。除非合同另有约定,华为公司对本文档内容不做任何明示或默示的声 明或保证。

由于产品版本升级或其他原因,本文档内容会不定期进行更新。除非另有约定,本文档仅作为使用指导,本文 档中的所有陈述、信息和建议不构成任何明示或暗示的担保。

(3)

目 录

1 开通代码检查服务... 1

2 成员与权限的关系... 4

3 代码检查使用流程... 6

4 任务创建...8

4.1 准备工作...8

4.2 创建 DevCloud 任务... 10

4.3 创建 GitHub 任务... 11

4.4 创建通用 Git 任务...11

4.5 创建码云 Git 任务...12

5 任务执行...14

5.1 执行代码检查任务... 14

5.2 查看代码检查任务... 15

5.3 修改代码问题...16

6 规则集设置(可选)... 22

6.1 配置代码检查规则集... 22

6.2 自定义代码检查规则集... 25

6.3 查看规则详情...27

6.4 删除自定义检查规则集... 28

7 任务设置(可选)... 30

7.1 概述... 30

7.2 设置多分支检查... 32

7.3 设置代码安全扫描... 33

7.4 设置质量门禁...34

7.5 设置新问题检查的起始时间... 35

7.6 设置任务忽略检查文件路径... 36

7.7 设置任务执行计划... 37

7.8 开启/关闭消息通知... 38

7.9 设置接入构建依赖的镜像仓... 39

7.10 设置分支合并自动检查任务... 40

7.11 设置钉钉机器人发送群消息... 42

(4)

7.12 设置企业微信机器人发送群消息... 46

(5)

1

开通代码检查服务

前提条件

请先注册华为云帐号(如果华为云帐号已注册,请忽略该步骤),操作如下:

1. 登录华为云首页。

2. 单击页面右上方“注册”,根据提示信息完成注册,注册详细流程请参考帐号注 册。

背景信息

代码检查服务为免费使用,并提供10万行代码免费额度,使用量超出免费额度时,系 统将会提示开通按需使用或购买套餐。

● 开通前可以免费体验。

● 开通后可以免费使用,请根据实际需要开通代码检查服务。

须知

● 代码检查服务依赖项目管理服务,开通前请先开通项目管理服务。

● 服务的开通需要区分区域,因此开通前注意选择自己需要开通的区域。

● 服务开通后,需注意创建的资源也分区域。

例如,在“华北-北京四”中创建了“项目A”,在下次查看“项目A”时,需先切 换到“项目A”所在区域“华北-北京四”。

开通按需

步骤1 登录DevCloud控制台,在左侧导航中选择“代码检查”,单击“开通按需”。

(6)

步骤2 查看并确认服务开通详情,单击页面右下角“立即开通”。

步骤3 根据弹框提示单击“确定”。

步骤4 页面右上角提示开通进行中,成功开通后系统自动返回控制台。

在“开通记录”页签查看服务开通记录。

----结束

关闭服务

步骤1 登录DevCloud控制台,在左侧导航中单击“代码检查”。

(7)

步骤2 选择“开通记录”页签,单击操作列“关闭服务”

步骤3 在弹框中根据提示输入“关闭服务”,单击“确认”。

步骤4 页面提示“已成功取消代码检查服务”,开通记录中“状态”显示为“已关闭”。

----结束

(8)

2

成员与权限的关系

角色权限表

针对项目下资源,介绍代码检查中用户默认的角色权限说明,如表2-1所示。

● 如果需要自定义角色(如“产品经理”),请通过“设置 > 项目设置 > 权限设 置”进行定义。详细操作请参见项目内权限设置。

● 如果需要修改成员角色,请通过“设置 > 通用设置 > 成员管理”进行修改。详细 操作请参见设置成员角色。

2-1 代码检查默认角色权限说明 角色/

操作

代码检查任务 检查规则集 规 则

问题列表 消息通知

项目 创建 者

● 查看、删 除、执行、

修改项目下 所有成员的 任务,有新 建权限。

新建、删除、

修改自己创建 的规则集,查 看、使用他人 的规则集。

看 ● 查看、导出问 题列表

● 搜索、筛选问 题

● 查看问题详情

● 导入忽略问题

● 处理问题、新 增处理意见

● 查看问题处理 历史记录

开启、关闭消 息通知。

项目 经理

(9)

角色/

操作

代码检查任务 检查规则集 规 则

问题列表 消息通知

开发

人员 ● 删除、执 行、修改自 己创建的任 务,查看所 在项目下所 有成员的任 务,有新建 权限。

● 对同一仓库 的其他成员 创建的任务 有查看、执 行、编辑权 限。

测试

经理 ● 无新建、查 看权限。

新建、删除、

修改自己创建 的规则集,查 看他人的规则 集。

- -

测试

人员 - -

参与

者 - -

浏览

者 - -

“自 定义 角 色”

- -

成员角色类型的设置方法

代码检查中的成员及成员类型来源项目管理,成员的角色权限请参见角色权限表。如 果需要修改成员的角色类型,请联系项目创建者或项目管理员进行修改,角色的设置 方法请参见设置成员角色。

(10)

3

代码检查使用流程

代码检查使用流程

介绍在“代码检查”中,代码检查的基本使用流程。

3-1 基本使用流程

(11)

流程使用说明

流程 说明

任务创建 在代码检查首页工具栏选择“服务 > 代码检查”进入,单击“代码检 查”首页的“新建任务”创建代码检查任务。新建任务时选择代码源配 置目标代码,请参见4 任务创建。

任务执行 代码检查任务新建成功后,进入任务详情页,单击“开始检查”执行检 查。检查完成后,可以查看任务详情和修改代码问题,请参见5 任务执 行。

规则集设 置(可 选)

代码检查支持默认的Java、C++、PHP、C#、JavaScript、TypeScript、

HTML、CSS、Go和Python语言的规则集,根据实际需要可以新增、复 制、修改或删除自定义规则集,请参见6 规则集设置(可选)。

任务设置

(可选) 用户可以对已有的检查任务进行修改或任务设置,请参见7 任务设置

(可选)。

(12)

4

任务创建

4.1 准备工作

4.2 创建DevCloud任务 4.3 创建GitHub任务 4.4 创建通用Git任务 4.5 创建码云Git任务

4.1 准备工作

背景信息

在创建代码检查任务前,请先做好如下准备工作:

● 创建项目

● 创建代码仓库(仅针对DevCloud代码源)

● 创建服务扩展点(针对GitHub、通用Git和码云三种代码源)

● 代码检查入口

创建项目

请在项目管理中完成项目的创建,支持Scrum项目和看板项目两种类型,类型不限。

创建代码仓库

请在代码托管中完成代码仓库的创建。

创建服务扩展点

在“服务扩展点管理”中,创建代码检查任务所需的代码源,请根据实际需要创建代 码源:

● GitHub

● 通用Git

(13)

● 码云Git

在项目的“设置 > 通用设置 > 服务扩展点管理”,单击“新建服务扩展点”,选择所 需类型,完成创建即可。详细创建方法请参见服务扩展点。

代码检查入口

介绍代码检查服务入口、以及进入代码检查首页可以使用的功能。

步骤1 在项目管理首页上方功能菜单区单击“服务 > 代码检查”。

进入到代码检查首页,包括“任务”、“规则集”和“规则”页签,默认显示“任 务”页签。

步骤2 单击“新建任务”,可以新建代码检查任务。

步骤3 在代码检查任务列表中查看检查任务的“新问题”、“未解决”、“已解决”等。

(14)

说明

● 新问题:

表示代码检查任务执行后需要处理的新问题。如果新问题数显示“0”,表示检查结果没有 需要处理的新问题。

● 未解决:

表示代码检查任务执行后需要处理的问题。如果未解决问题数显示“0”,表示检查结果没 有需要处理的问题。

● 已解决:

表示代码检查任务执行后已经处理完成的问题。

步骤4 选择“规则集”页签,单击“新增规则集”可以设置代码检查规则及检查规则集。

----结束

4.2 创建 DevCloud 任务

背景信息

适用于创建DevCloud代码源任务,代码源来源请参见4.1 准备工作。

操作步骤

步骤1 单击代码检查任务首页“新建任务”。

进入到“新建任务”页面,“源码源”选择“DevCloud”。

说明

如果项目下未准备DevCloud“源码源”,请参见准备工作。

步骤2 单击“创建”即可完成任务的创建。

步骤3 (可选)创建完成后,进入代码检查任务详情页,可根据需要执行代码检查任务。

----结束

(15)

4.3 创建 GitHub 任务

背景信息

适用于创建GitHub代码源任务,代码源来源请参见4.1 准备工作。

操作步骤

步骤1 单击代码检查任务首页“新建任务”。

进入到“新建任务”页面,“源码源”选择“GitHub”。

说明

● 如果项目下未准备GitHub“源码源”,请参见准备工作。

● 将Github仓库设置成公开。

步骤2 根据实际情况设置Endpoint实例、Repository、Branch和检查语言。

步骤3 单击“创建”即可完成任务的创建。

步骤4 (可选)创建完成后,进入代码检查任务详情页,可根据需要执行代码检查任务。

----结束

4.4 创建通用 Git 任务

背景信息

适用于创建通用Git代码源任务,代码源来源请参见4.1 准备工作。

(16)

操作步骤

步骤1 单击代码检查任务首页“新建任务”。

进入到“新建任务”页面,“源码源”选择“通用Git”。

说明

如果项目下未准备通用Git“源码源”,请参见准备工作。

步骤2 根据实际情况设置Endpoint实例、Repository、Branch和检查语言。

步骤3 单击“创建”即可完成任务的创建。

步骤4 (可选)创建完成后,进入代码检查任务详情页,可根据需要执行代码检查任务。

----结束

4.5 创建码云 Git 任务

背景信息

适用于创建码云Git代码源任务,代码源来源请参见4.1 准备工作。

操作步骤

步骤1 单击代码检查任务首页“新建任务”。

进入到“新建任务”页面,“源码源”选择“码云”。

(17)

说明

如果项目下未准备码云Git“源码源”,请参见准备工作。

步骤2 根据实际情况设置Endpoint实例、Repository、Branch和检查语言。

步骤3 单击“创建”即可完成任务的创建。

步骤4 (可选)创建完成后,进入代码检查任务详情页,可根据需要执行代码检查任务。

----结束

(18)

5

任务执行

5.1 执行代码检查任务 5.2 查看代码检查任务 5.3 修改代码问题

5.1 执行代码检查任务

前提条件

检查任务已建立并具有相关权限。

背景信息

用户可以对目标代码检查任务执行检查,及时发现源代码中的代码问题。执行代码检 查有两种方式:

● 手动执行:参见本节介绍的操作步骤。

● 定时执行:设置代码检查任务的执行计划。

操作步骤

步骤1 在代码检查首页下方搜索目标检查任务。

步骤2 单击代码检查任务所在行“开始检查”,进入“开始检查”执行代码检查。

步骤3 根据页面提示等待片刻,执行完成后,进入代码检查详情页面,默认显示“概览”页 签。

(19)

----结束

5.2 查看代码检查任务

前提条件

检查任务已执行完成并具有权限。

背景信息

代码检查任务查看详情包括:概览、代码问题、代码度量、以及任务配置信息。

查看代码检查任务详情

步骤1 在代码检查首页搜索目标任务。

步骤2 单击检查任务名称链接,进入查看代码检查任务详情页面。

1. 查看任务概览。

2. 查看并修改代码问题。

– 单击代码问题页签,即可对每个问题进行查看。

– 左侧过滤器支持通过问题级别、问题状态、检测时间等对问题进行过滤筛 选。

– 单击修改建议,显示问题的修改建议、正确示例、错误示例。

3. 代码度量。

支持查看代码圈复杂度和代码重复率文件的度量值。

----结束

查看任务概览

在执行完代码检查任务后,展示检查结果的数据图表。

步骤1 进入代码检查任务详情页面。

(20)

步骤2 默认显示“概览”页签。

----结束

查看任务徽标状态

执行完代码检查任务后,可以查看任务检查结果的徽标状态。

步骤1 进入代码检查任务详情页面。

步骤2 在“设置”页签,单击“徽标状态”。

显示任务的徽标状态,查看方式目前支持“HTML”和“MarkDown”。

----结束

5.3 修改代码问题

背景信息

执行完代码检查任务后,查看代码问题:

● 可以根据不同条件筛选代码问题

(21)

● 在问题列表中对每个问题有修改建议,可参考

● 在问题列表中可以分配问题责任人

● 修改代码圈复杂度问题

● 修改代码重复率问题

修改代码问题

步骤1 进入代码检查任务详情页面。

步骤2 选择“代码问题”页签,进入“代码问题”详情页面。

5-1 代码问题操作说明 操作项 说明

问题级 别

致命、严重、一般、提示。

问题状 态

未解决、已解决、已忽略。

问题检

测时间 新问题、所有问题,在“设置 > 高级选项”中可以设置新问题起始时 间,问题发现时间在起始时间之后的则为新问题。

规则 按照问题命中的规则进行分类统计,便于用户一次性解决同一类问题。

文件目 录

按照源文件所在目录分类统计。

语言 按照语言进行分类统计

(22)

操作项 说明

负责人 分配问题负责人。

步骤3 单击“问题描述”显示问题详情。

包括文件路径、问题描述、问题级别、问题状态、负责人、以及修改建议等。

步骤4 请根据实际情况单击“修改建议”修改代码检查问题,或将问题分配给相关责任人。

----结束

分配问题负责人

代码检查过程中,自动将新问题分配给问题代码行的最后一次提交者。

说明

如果提交代码者不在代码仓库用户列表中,则不会分配。

步骤1 进入配置任务页面。

步骤2 选择“代码问题”页签,根据需要选择“问题级别”和“问题状态”等。

(23)

步骤3 如果问题显示“未分配”负责人,单击“未分配”可设置问题负责人。

(24)

----结束

修改代码圈复杂度问题

步骤1 进入代码检查任务详情页面。

步骤2 选择“代码度量”页签,可以查看已检查的源码圈复杂度。

步骤3 单击文件名称进入文件详情页面,可以查看文件源码。

----结束

修改代码重复率问题

步骤1 进入代码检查任务详情页面。

步骤2 选择“代码度量”页签,可以查看已检查的源文件代码重复率。

步骤3 单击文件名称进入文件详情页面。

步骤4 单击 可以查看文件源码,文件左侧行的竖线标识了重复的代码块,单击标识竖线,

将会显示与该段代码重复的文件列表。

(25)

步骤5 单击文件名称,可对比查看两文件的重复代码块。

----结束

(26)

6

规则集设置(可选)

6.1 配置代码检查规则集 6.2 自定义代码检查规则集 6.3 查看规则详情

6.4 删除自定义检查规则集

6.1 配置代码检查规则集

背景信息

代码检查默认支持Java、C++、PHP、C#、JavaScript、TypeScript、HTML、CSS、Go 和Python语言的规则集,且每种语言类型对应多种不同级别的规则集,默认规则集如 表6-1所示。

6-1 默认规则集类型

语言 默认规则集类型

Java ● CodeCheck推荐规则集

● 关键检查规则集

● 通用检查规则集

● 全面检查规则集

● 安全检查规则集

● 移动领域-Android规则集

● Google编码规范规则集 CSS ● 通用检查规则集

JavaScript ● 关键检查规则集

● 通用检查规则集

● 全面检查规则集

(27)

语言 默认规则集类型

TypeScript ● CodeCheck推荐规则集

● 关键检查规则集

● 通用检查规则集

● 全面检查规则集 HTML ● 通用检查规则集 C++ ● 关键检查规则集

● 通用检查规则集

● 全面检查规则集 PHP ● 关键检查规则集

● 通用检查规则集 C# ● 关键检查规则集

● 通用检查规则集

● 全面检查规则集 Go ● 关键检查规则集

● 通用检查规则集

● 全面检查规则集 Python ● 关键检查规则集

● 通用检查规则集

根据实际需要可以新增、复制规则集;修改或删除自定义规则集。

操作步骤

步骤1 单击代码检查首页“规则集”页签,进入检查规则集列表页面。

步骤2 单击代码检查首页“规则”页签,进入检查规则页面。

(28)

说明

● 系统规则集和已使用的规则集不能删除。

● 系统规则集只能查看和复制。

步骤3 请根据需要创建、修改、删除、查看、复制或配置规则集。

6-2 规则集操作说明 操作项 说明

搜索 检查规则支持输入规则名称搜索。

筛选 “规则集”配置页面支持用户自定义过滤规则,即设置自定义过滤条 件。

新增规则集 单击“新增规则集”可以自定义规则集,请参见6.2 自定义代码检查 规则集。

查看规则集 单击规则集名称可以查看检查规则集详情。

修改(配

置)规则集 单击规则集所在行的 ,选择“配置”,进入“规则集配置”页面,

可以根据实际需要修改规则集并保存。

删除规则集 单击规则集所在行的 ,选择“删除”可以删除检查规则集。

复制规则集 单击规则集所在行的 ,选择“复制”,在弹出的“复制检查规则 集”窗口设置规则集名称后,单击“确定”。

说明

规则集名称不能重名。

默认规则集

(项目下) 在项目下的规则集列表页面,单击规则集所在行的 ,选择“默认”

可以设置该规则集为该项目下任务对应语言的默认检查规则集。

设置规则集 进入某个检查任务详情页面,选择“设置 > 规则集”页签,选中已新 建好的规则集设置为任务检查规则集。

----结束

(29)

6.2 自定义代码检查规则集

前提条件

目前仅支持配置单语言的规则集,即一种规则集只能配置同一种语言类型的检查规 则。

背景信息

● 代码检查除了默认规则集类型外,还可以根据实际需要自定义代码检查规则集。

新规则集定义完成后,将代码检查任务的规则集修改为新规则集即可。

● 每个规则集模板至少需设置一条规则。

操作步骤

步骤1 在代码检查首页单击“规则集”页签。

默认进入规则集列表页面。

步骤2 单击“新增规则集”,即添加自定义代码检查规则集。

在弹出的“新建检查规则集”窗口设置规则集名称、选择检查语言、设置基于某种语 言的规则集(系统规则集或自定义规则集),单击“确定”。

步骤3 给规则集配置检查规则。

1. 单击目标自定义规则集名称 。 进入检查规则集配置页面。

(30)

2. 勾选或取消勾选目标规则后,单击下方黄色标签“新启用X条,新关闭X条”,可 查看本次操作的规则。

可重新勾选或取消勾选目标规则,重置本次操作。

3. 单击“保存”会弹出确认提示框,单击“确定”保存本次操作。

(31)

步骤4 将代码检查任务使用的检查规则集修改为自定义规则集。

进入代码检查任务详情页面,在“设置 > 规则集”中打开目标语言的开关 ,并 选中目标语言已配置好的自定义规则集。

----结束

6.3 查看规则详情

背景信息

规则详情包含:问题级别(如“一般”)、“正确示例”、“错误示例”以及“修改 建议”等。

操作步骤:方式一

步骤1 单击代码检查首页“规则”页签。

步骤2 单击不同语言类型,右侧显示对应的规则详情。

----结束

(32)

操作步骤:方式二

步骤1 单击代码检查首页“规则集”页签。

步骤2 单击规则集名称。

进入规则列表页面。

步骤3 单击规则名称,右侧显示对应的规则详情。

----结束

6.4 删除自定义检查规则集

前提条件

● 只有创建者可以删除规则集。

● 系统规则集和已被使用的规则集不能删除。

背景信息

检查规则集如果已关联在代码检查任务中,则无法被删除。将关联使用该规则集的代 码检查任务删除、或将代码检查任务关联其它规则集后,即可删除自定义规则集。

操作步骤

步骤1 单击代码检查首页“规则集”页签。

进入规则集列表页面。

步骤2 如果检查规则集已被使用,请先将使用该规则集的代码检查任务删除、或将代码检查 任务改用其它规则集。

步骤3 单击规则集所在行的 ,选择“删除”可以删除检查规则集。

(33)

----结束

(34)

7

任务设置(可选)

7.1 概述

7.2 设置多分支检查 7.3 设置代码安全扫描 7.4 设置质量门禁

7.5 设置新问题检查的起始时间 7.6 设置任务忽略检查文件路径 7.7 设置任务执行计划

7.8 开启/关闭消息通知

7.9 设置接入构建依赖的镜像仓 7.10 设置分支合并自动检查任务 7.11 设置钉钉机器人发送群消息 7.12 设置企业微信机器人发送群消息

7.1 概述

前提条件

任务创建者、项目创建者或项目管理员可以修改、删除、设置代码检查任务。

背景信息

用户可以对已有的检查任务进行修改或任务设置:

● 修改任务名称、默认分支

● 删除任务

● 对任务进行设置,如质量门禁、忽略文件、执行计划、消息通知等

(35)

修改代码检查任务

步骤1 在代码检查首页搜索目标任务。

步骤2 单击代码检查任务所在行 。

步骤3 单击“设置”,进入“设置”页面,可以修改任务的基本信息(任务名称、分支)、

规则集、执行计划等。

步骤4 修改完成后并保存。

----结束

删除代码检查任务

步骤1 在代码检查首页搜索目标任务。

步骤2 单击代码检查任务所在行 。

(36)

步骤3 单击“设置”,进入“设置 > 基本信息”页面。

步骤4 单击“删除任务”,根据提示信息完成删除。

----结束

7.2 设置多分支检查

背景信息

在任务查看页面可以看到“已检查”和“未检查”的分支,可自由切换分支进行检 查。

操作步骤

步骤1 进入代码检查任务详情页面。

步骤2 默认显示“概览”页签,根据需要可以切换不同分支。

7-1 多分支检查

步骤3 切换目标分支后,单击“启动任务”进行检查。

----结束

(37)

7.3 设置代码安全扫描

前提条件

目前安全扫描规则设置仅针对Java语言。

背景信息

● 代码检查除了默认规则集类型外,还可以根据实际需要自定义代码检查规则集。

新规则集定义完成后,将代码检查任务的规则集修改为新规则集即可。

● 本节以新建Java检查任务,选择默认的“安全检查规则集”为例操作。

如果Java检查任务已创建且设置的规则集不是“安全检查规则集”,修改为该规 则集即可。

操作步骤

步骤1 在代码托管中创建Java代码仓库并保存。详细操作请参见代码托管。

步骤2 在代码检查中单击“新建任务”。

进入“创建任务”页面,默认“源码源”为“DevCloud”。

(38)

步骤3 单击步骤1已创建的Maven仓库所在行“创建”即可完成Java代码检查任务创建。默认 进入Maven(Java)检查任务详情页面。

步骤4 单击“设置 > 规则集 > Java >(启用)安全检查规则集 ”。

步骤5 (可选)如果Java检查任务已创建且设置的规则集不是“安全检查规则集”,将代码 检查任务使用的检查规则集修改为“安全检查规则集”即可。

直接进入代码检查任务详情页面,在“设置 > 规则集”中打开目标Java语言的开关

,并选中“安全检查规则集”。

----结束

7.4 设置质量门禁

背景信息

根据质量要求设置门禁阈值,超过阈值将提示门禁结果Failed。

操作步骤

步骤1 进入代码检查任务详情页面。

(39)

步骤2 单击“设置”页签,选中“质量门禁”。

步骤3 根据质量要求设置门禁开关和阈值。

步骤4 执行检查并查看检查结果。

----结束

7.5 设置新问题检查的起始时间

背景信息

在每个任务的基础上可以设置新问题起始时间。

说明

默认起始时间为当前任务第一次检查成功的时间,起始时间之后检查出的所有问题属于新问题。

操作步骤

步骤1 进入配置任务页面。

步骤2 选择“设置 > 高级选项”。

(40)

步骤3 在“新问题起始时间”中设置新问题起始时间。

----结束

7.6 设置任务忽略检查文件路径

背景信息

支持用户以任务为单元,设置代码检查的文件范围:

● 如果文件范围路径为空,即不选时,则检查所选仓库分支的所有代码。

● 如果设置指定文件路径,则指定路径下的文件将排除检查。

● 文件路径不支持修改。

操作步骤

步骤1 进入代码检查任务详情页面。

步骤2 选择“设置 > 忽略文件”。

步骤3 在“忽略的文件集合”中排除检查文件路径。

(41)

步骤4 文件路径设置后,执行代码检查任务,将按照设置排除选中的路径执行检查(如上图 排除了“images”文件)。

----结束

7.7 设置任务执行计划

背景信息

用户可以根据自己的需要,设置代码检查任务的执行计划。

操作步骤

步骤1 进入代码检查任务详情页面。

步骤2 选择“设置 > 执行计划”。

步骤3 开启“定时计划”。

(42)

● 支持用户以周为周期,配置一周内某天、某时间段开始代码检查任务。

● 支持用户设置成“代码提交时执行”,即当代码提交时,自动执行检查任务。

----结束

7.8 开启/关闭消息通知

背景信息

用户可以根据自己的需要,设置 “任务检查完成” 和 “删除任务” 的通知提醒。

目前支持的提醒方式为“服务动态”和“邮件”。

操作步骤

步骤1 进入代码检查任务详情页面。

步骤2 在“设置”页签,单击“通知管理”。

步骤3 根据需要开启/关闭事件类型的通知状态。

事件类型目前支持“任务检查完成”和“删除任务”。

通知方式目前支持“服务动态”和“邮件”。

(43)

----结束

7.9 设置接入构建依赖的镜像仓

背景信息

代码扫描需要编译时,一般从镜像仓就可以下载到依赖包,不需要该“编译配置”。

而对于私有云场景,用户有自己搭建的镜像仓,需要设置“编译配置”检查。

操作步骤

步骤1 设置好setting文件。

把私有依赖仓的地址设置到setting文件中,并放到代码仓上,如放到“src/private- settings.xml”。

步骤2 打开代码检查任务,选择“设置 > 规则集 > 编译配置”。

步骤3 设置编译命令,加上-s参数指定settings文件,执行检查即可下载私有依赖包。

(44)

----结束

7.10 设置分支合并自动检查任务

背景信息

当代码托管中有分支合并时,在代码检查服务中可以设置自动检查代码检查任务,并 生成一个子任务,即代码仓库中有分支合并,就会重新生成一个代码检查子任务。

操作步骤

步骤1 进入代码检查任务详情页面。

步骤2 在“设置”页签,单击“集成与服务”。

会显示Codehub集成功能。

步骤3 开启“CodeHub”功能,勾选“MR检查状态”。

步骤4 单击“保存”。此时在“保存”后会显示“成功”字样。

(45)

步骤5 当所在任务的代码仓库中有分支合并时,代码检查服务会自动生成一个代码检查子任 务。

1. 在代码托管CodeHub中新建MR请求:

2. 刷新CodeHub页面,可以看到CodeCheck任务已经触发。

3. 单击链接可以跳转到CodeCheck的MR任务。

(46)

4. 通过下拉分支菜单,可以查看到所有MR的历史记录。

----结束 说明

合并分支相关操作请参见代码托管用户指南。合并分支后,只检查代码分支的差异部分。

7.11 设置钉钉机器人发送群消息

前提条件

请先复制准备好钉钉群机器人的Webhook地址。

背景信息

用户可以在代码检查中配置钉钉群通知服务,为钉钉群自动发送代码检查任务的运行 结果。操作流程如下:

(47)

步骤一:在钉钉群里添加钉钉机器人

在钉钉群中创建钉钉机器人,请参阅文档:钉钉开放平台文档。

请注意:进入钉钉机器人的安全设置时,需填写自定义关键词“CodeCheck”,如图 7-2所示。

7-2 在钉钉群中添加机器人

步骤二:在代码检查中配置钉钉群通知服务

步骤1 进入代码检查任务详情页面。

步骤2 在“设置”页签,单击“集成与服务”。

步骤3 开启“钉钉”通知,如图7-3所示。

(48)

7-3 在代码检查中配置使用钉钉群通知

步骤4 填写Webhook地址,单击“测试”,验证Webhook地址是否正确可用。

步骤5 确认Webhook地址可用后,单击“保存”。

当检查完成时,代码检查服务会发送检查结果概要到指定的钉钉群。发送示例如下:

(49)

----结束

(50)

7.12 设置企业微信机器人发送群消息

前提条件

请先复制准备好企业微信群机器人的Webhook地址。

背景信息

用户可以在代码检查中配置企业微信群通知服务,为企业微信群自动发送代码检查任 务的运行结果。操作流程如下:

步骤一:在企业微信群里添加微信机器人

在企业微信群中创建群机器人,请参阅文档:如何配置企业微信机器人。

步骤二:在代码检查中配置企业微信群通知服务

步骤1 进入代码检查任务详情页面。

步骤2 在“设置”页签,单击“集成与服务”。

步骤3 开启“企业微信”通知,如图7-4所示。

7-4 在代码检查中配置使用企业微信群通知

步骤4 填写Webhook地址,单击“测试”,验证Webhook地址是否正确可用。

步骤5 确认Webhook地址可用后,单击“保存”。

当检查完成时,代码检查服务会发送检查结果概要到指定的企业微信群。发送示例如 下:

(51)

----结束

參考文獻

相關文件

附表 1-1:高低壓電力設備維護檢查表 附表 1-2:高低壓電力設備維護檢查表 附表 1-3:高低壓電力設備(1/13) 附表 2:發電機檢查紀錄表. 附表

[r]

(1) 輸入 http://kpptr.wda.gov.tw 本分署網站,功能選項中點選「職業訓練」→點選「訓 練課程查詢及報名」.. (2)

elementary row operations reduced echelon form,. echelon form Gauss

augmented matrix [A |I 4 ], elementary row operation A

column vector

Proposition 9.4.2, A orthogonal diagonalizable, Spectral Theorem.. Theorem 9.4.6

, A echelon form ( reduced echelon form) pivot column vectors.. elementary row operations column