检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
CodeArts Check最佳实践汇总 本文汇总了基于代码检查服务(CodeArts Check)常见应用场景的操作实践,为每个实践提供详细的方案描述和操作指导,帮助用户轻松检查代码。 表1 CodeArts Check最佳实践一览表 最佳实践 说明 使用预置规则检查GitCode
配置代码检查任务自定义规则集 代码检查服务除了可以使用预置规则集类型,用户还可以根据实际需要自定义代码检查规则集,每个规则集中最少设置一条规则。 目前仅支持配置单语言的规则集,即一种规则集只能配置同一种语言类型的检查规则。 代码检查规则集提供了代码安全检查增强包功能,使用前请务必按需购买
API概览 表1 代码检查API概览 类型 子类型 说明 代码检查 任务管理 任务管理包括:新建、执行、查询、终止任务等。 缺陷管理 缺陷管理包括:问题概述、问题状态、圈复杂度、代码重复率等缺陷详情。 规则管理 规则管理包括:获取规则列表接口、创建自定义规则集、查询规则集列表等。
欠费说明 用户在使用云服务时,账户的可用额度小于待结算的账单,即被判定为账户欠费。欠费后,可能会影响云服务资源的正常运行,请及时充值。 欠费原因 自动续费情况下,可能会因持续性周期扣款而导致账户的余额不足。 欠费影响 由于代码检查服务采用包年/包月计费方式,购买时已经预先支付了资源费用
API 任务管理 缺陷管理 规则管理
旧版本开通/关闭按需计费方式说明 本章节仅供老用户参考。 CodeArts旧版计费包括包年/包月套餐购买及服务组合开通方式。 也可单独开通代码检查服务。单独开通的计费方式请参见旧版代码检查计费方式如何收费?。 前提条件 请先注册华为账号并开通华为云(如果华为云账号已注册并开通华为云
资源扩展包 代码检查提供的资源扩展包为并发扩展,采用包年/包月,可增加检查任务并发执行数。 代码检查并发扩展 表1 代码检查并发扩展 计费方式 包年/包月 适用场景 当代码检查服务套餐中包含的代码检查任务并发数不满足实际使用需求时,可购买代码检查并发扩展。 计费项 并发数。 购买限制
续费概述 续费简介 包年/包月服务到期后会影响代码检查服务正常运行。如果您想继续使用,需要在指定的时间内为代码检查服务续费。 代码检查服务在到期前续费成功,代码检查服务可正常使用,且代码检查任务的运行不受影响。代码检查服务到期后的状态说明,请参见到期后影响。 续费相关的功能 代码检查服务续费相关的功能如表
使用自定义执行机执行代码检查任务 应用场景 当CodeArts Check提供的内置执行机不满足业务要求时,您可接入自行提供的执行机,通过注册的方式托管到CodeArts Check服务中,委托CodeArts Check服务进行调度并执行代码检查任务。本实践我们通过检查CodeArts
HE2E DevOps实践:代码检查 本文以“DevOps全流程示例项目”为例,介绍如何在项目中进完成代码检查配置。 开展实践前,需要完成创建项目和创建仓库。 预置任务简介 样例项目中预置了以下4个代码检查任务。 表1 预置任务 预置任务 任务说明 phoenix-codecheck-worker
功能总览 功能总览 全部 代码检查 计费说明 规则集设置 任务设置 API 代码检查 CodeArts Check(原CodeCheck)是基于云端实现的代码检查服务。为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面质量报告、便捷的问题闭环处理帮助企业有效管控代码质量
“代码编写、代码合并、版本发布”三层缺陷防护 “代码编写、代码合并、版本发布”三层缺陷防护,兼顾效率与质量 优秀的代码质量保障实践,往往将代码检查融入到开发作业流中,在用户代码编写、代码提交时进行自动化的审计检查,并对团队每日产出的代码进行持续编程规范和质量检查。 这一活动实践要求已是安全开发过程
配置代码检查任务消息通知 您可以根据实际需求,设置代码检查任务事件类型的通知方式。 例如,当检查任务的门禁失败时,可以设置以服务动态或邮件方式通知用户,并可配置通知的接收者角色和自定义成员。若不配置接收者角色及成员,门禁失败时向任务执行者发送通知;若配置,则向任务执行者、配置的接收者角色以及自定义成员发送通知
成长地图 | 华为云 代码检查 CodeArts Check(原CodeCheck)是基于云端实现的代码检查服务。为用户提供代码风格、通用质量与网络安全风险等丰富的检查能力,提供全面质量报告、便捷的问题闭环处理帮助企业有效管控代码质量,助力企业成功。 产品概述 图说Check 立即使用
快速检查CodeArts Repo代码仓库中的代码质量 在代码开发过程中,编程人员能力和代码风格不一致,会影响代码的可阅读性和可维护性,例如代码注释要求。或者在某个平台/行业的代码编写要求比较特殊等一列问题,可通过使用代码检查服务检查代码质量。 本示例为您演示检查CodeArts
认证鉴权 调用接口有如下两种认证方式,您可以选择其中一种进行认证鉴权。 Token认证:通过Token认证通用请求。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。 Token认证 Token的有效期为24小时,需要使用一个
CodeArts Check插件使用指南(IntelliJ IDEA版本) 本插件致力于守护开发人员代码质量,成为开发人员的助手和利器。秉承极简、极速、即时看护的理念,提供业界规范的检查、代码风格一键格式化及代码自动修复功能。 安装CodeArts Check插件 在IDEA IDE
修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二十四次正式发布。本次变更说明如下: 修改错误码。 2023-01-09 第二十三次正式发布。本次变更说明如下: 增加获取任务的目录树。 增加任务配置屏蔽目录。 增加查询任务的高级配置
配置代码检查任务预置规则集 规则集则是一组用于做代码检查的规则组成的集合。一般根据不同的检查目标和需求,规则集也有相应的分类,比如对安全类、安卓应用、编程风格,使用这些类别进行检查的时候,规则集内的规则也会有所不同。 用户可根据实际需要更换代码检查任务使用的规则集,新启用的规则集将在下一次执行检查时生效
执行代码检查任务时提示:在Maven仓库中找不到依赖 问题现象 代码检查报错,错误日志中提示在Maven仓库中找不到依赖(该依赖为私有依赖)。 原因分析 项目中使用了私有依赖,但没有配置私有依赖扩展点。 处理方法1 在代码检查详情页,选择“设置 > 规则集 > 检查参数”。 在编译命令中使用