检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
购买并授权使用CodeArts Check 购买CodeArts Check
执行代码检查任务 用户可以对目标代码检查任务执行检查,及时发现源代码中的代码问题。 执行代码检查有两种方式: 手动执行:创建完代码检查任务后手动执行代码检查任务。本章节介绍的为手动执行代码检查任务的操作指导。 定时执行:多用于日常执行代码检查,配置详情可参考配置代码检查任务定时执行。
编辑 √ √ √ × × × × × √ √ √ 前提条件 已购买CodeArts Check。 已参考软件开发生产线(CodeArts)的“用户指南 > 软件开发生产线(CodeArts)使用前准备 > 添加CodeArts项目成员”章节添加成员,并为新增的成员赋予角色。 访问CodeArts
变更代码检查服务规格 变更代码检查服务套餐规格 代码检查服务支持变更套餐规格,变更影响请参见变更配置后对计费的影响。 登录代码检查控制台。 找到代码检查服务套餐,单击“变更”。 根据需要选择变更规格、变更类型,勾选同意声明,单击“下一步”。 若变更类型选择“续费变更”,则还需要选择续费时长。
配置代码检查任务规则集 配置代码检查任务预置规则集 配置代码检查任务自定义规则集 父主题: 配置代码检查任务
单击规则集所在行的,选择“默认规则集”,即可将当前的规则集设置为默认规则集。 配置代码检查任务使用的规则集 如果用户需要在代码检查任务中使用其他的预置规则集,可参考以下指导操作。如果预置规则集不满足用户的检查需求,可参考配置代码检查任务自定义规则集。 进入代码检查页面,在任务列表中,单击任务名称。
当所在任务的代码仓库中有分支合并时,代码检查服务会自动生成一个代码检查子任务。 进入代码检查任务详情页面。 单击,在代码托管中新建MR请求。 合并分支相关操作请参见代码托管用户指南。 单击,通过下拉框中,可查看所有的MR触发代码检查的历史记录。 配置代码提交时执行 勾选“代码提交时执行”,表示对代码仓提交代码时会触发执行代码检查任务。
查看徽标状态 执行完代码检查任务后,您可通过徽标状态查看代码健康度,并标识在代码仓库中。 代码检查服务中设置各个告警级别的影响度如下: 致命:5 严重:3 一般:1 提示:0.1 健康度=SUM ∑(告警数量*告警级别影响度)/代码量,各个健康度对应的标识如下: A:健康度<=0
再单独购买代码检查服务套餐。 购买CodeArts Check 代码检查服务采用包年/包月计费模式,提供基础版、专业版套餐,以满足不同规模用户的使用需求。套餐详情介绍请参见包年/包月套餐说明。 进入购买CodeArts Check套餐页面。 参考表1根据实际需要进行购买。 表1 套餐包配置
提供9000条以上典型检查规则。 提供多维度质量统计报表,如质量门禁和代码健康度徽标等。 精准 精确定位缺陷,提供修复指导。 支持用户自定义检查规则集,精准检查用户关注缺陷。 全面 支持Java/C++/JavaScript/Go/Python/C#/TypeScript/CSS/HTM
应用于检查某类代码问题。提供规则说明,如代码缺陷影响、修改建议。 规则集 针对具体语言而定义的检查规则集合,提高用户代码质量。 圈复杂度 圈复杂度是一种代码复杂度的衡量标准,与其可维护性和可测试性之间存在相关性,这意味着在圈复杂度较高的文件中,重构代码出错的概率较高。代码平均圈复杂度 = 总圈复杂度/函数数。具体风险评估建议如下:
配置代码检查任务质量门禁 根据质量要求设置门禁阈值,即可了解您的项目是否已准备好投入生产。例如,实际的检查结果超出设置的门禁阈值,则表示当前项目还不具备生产条件。 门禁质量设置支持租户级、项目级以及任务级,优先级为租户级 > 项目级 > 任务级。入口分别如下: 租户级:进入代码检
最多只能添加7个扩展点。 完成后,单击“保存”。 配置检查前置命令 您可以在执行代码检查之前,根据实际情况设置“检查前置命令”,运行该命令可以搭建用户自定义的扫描环境。 在“检查前置命令”区域,输入检查前置命令。 单击“保存”。 父主题: 配置代码检查任务
配置代码检查任务定时执行 根据实际需要,设置代码检查任务的执行计划,定时执行默认分支的检查任务。 建议在非流水线使用情况下进行配置。 配置当天时间间隔必须在5分钟以上。 配置执行计划 基于项目入口访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。
String 文件总数 folders_total String 目录总数 lines_per_file String 文件平均代码行 huge_headerfile_total String 超大头文件数 huge_headerfile_ratio String 超大头文件占比 hu
2已忽略 rule_system_tags String 规则标签,多个标签用逗号隔开 rule_id String 规则id rule_name String 规则名 line_number String 缺陷所在文件行号 defect_content String 缺陷描述 defect_level
file_duplication_ratio String 文件重复率 new_count Integer 新增问题数 solve_count Integer 已解决问题数 duplicated_files Integer 重复文件数目 new_critical_count String
String 目录或文件的路径 offset 否 Integer 分页索引,偏移量 limit 否 Integer 每页显示的数量,每页最多显示1000条 请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。
代码检查 计费说明 规则集设置 任务设置 API 代码检查 CodeArts Check(原CodeCheck)是基于云端实现的代码检查服务。为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面质量报告、便捷的问题闭环处理帮助企业有效管控代码质量,助力企业成功。 支持区域:
已开通旧版代码检查服务,能否转换为新版本计费? 本章节仅供老用户参考。 当前暂不支持已开通旧版代码检查服务的用户一键切换成新计费模式,需要将旧版服务套餐关闭,再购买新套餐。 已购买包周期套餐的用户,套餐到期后,您可以选择继续购买包年/包月套餐,请参见包年/包月。 开通旧版按需计费的用户,仍延续旧版按需计费规则。旧版代码检查服务关闭方式请参见关闭服务。