修订记录 文档修订记录累积了每次文档更新的说明。最新版本的文档包含以前所有文档版本的更新内容。 修订记录 发布日期 第二次正式发布。本次变更说明如下: 代码检查改成新的服务名称(CodeArts Check)。 2022-04-23 第一次正式发布。 2022-09-30
使用公共API时提示没有权限 问题现象 使用公共API报没有权限。 原因分析 登录的用户没有权限。 Region信息不对。 处理方法 确认登录的用户是否有权限,详情见授权成员使用代码检查服务。 确认Region信息是否正确。 如果仍然未能解决,请联系技术支持工程师。 父主题: API
配置代码检查任务定时执行 根据实际需要,设置代码检查任务的执行计划,定时执行默认分支的检查任务。 建议在非流水线使用情况下进行配置。 约束与限制 配置当天时间间隔必须在5分钟以上。 配置执行计划 访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称
执行代码检查任务时提示:在Maven仓库中找不到依赖 问题现象 代码检查报错,错误日志中提示在Maven仓库中找不到依赖(该依赖为私有依赖)。 原因分析 项目中使用了私有依赖,但没有配置私有依赖扩展点。 处理方法1 在代码检查详情页,选择“设置 > 规则集 > 检查参数”。 在编译命令中使用
配置代码检查任务检查范围 用户可以根据实际需求设置检查模式和检查目录,提高检查效率。 约束与限制 secbrella引擎均不支持MR合入。 C#语言仅支持MR全量扫描模式。 设置MR检查模式 访问CodeArts Check服务首页。 进入代码检查页面,在任务列表中,单击任务名称。
新建检查任务 功能介绍 新建检查任务但是不执行。 调用方法 请参见如何调用API。 URI POST /v2/{project_id}/task 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: 项目的32位uuid,项目唯一标识,
灵活匹配用户场景 支持自定义规则,灵活匹配用户场景 在软件开发实践中,代码质量管控面临着多样化的现实挑战:例如,不同团队的编码规范存在差异(如特定命名规则、注释格式),复杂业务场景需要定制化逻辑校验,新兴技术框架的最佳实践需要强制落地,通用代码检查工具的内置规则往往聚焦于语法合规、
配置代码检查任务高级选项 当前“亚太-新加坡”、“土耳其-伊斯坦布尔”和“中东-利雅得”局点不支持该功能。 配置新问题起始时间 在每个任务的基础上可以设置新问题起始时间。起始时间设置之后要重新扫描,问题的发现时间大于设置时间将被划分为新问题。如果没有设置起始时间,连续两次的检查结果对比
执行代码检查任务 用户可以对目标代码检查任务执行检查,及时发现源代码中的代码问题。 执行代码检查有两种方式: 手动执行:创建完代码检查任务后手动执行代码检查任务。本章节介绍的为手动执行代码检查任务的操作指导。 定时执行:多用于日常执行代码检查,配置详情可参考配置代码检查任务定时执行
最新动态 本文介绍了代码检查 CodeArts Check的功能发布和对应的文档动态,新特性将在各个区域(Region)陆续发布,欢迎体验。 2024年7月 序号 功能名称 功能描述 阶段 相关文档 1 新增告警延迟上线功能 新增告警延迟上线功能,消减检查能力增强对存量代码的影响。
责任人精确匹配开关 功能介绍 查询责任人精确匹配开关 调用方法 请参见如何调用API。 URI GET /v1/tasks/{task_id}/owner-matching-switch 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 参数解释:
获取代码仓所有文件列表 功能介绍 获取代码仓所有文件的列表 调用方法 请参见如何调用API。 URI GET /v4/tasks/{task_id}/file-list 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 参数解释: 任务ID,即新建检查任务接口的返回值
取消检查 功能介绍 取消检查。 调用方法 请参见如何调用API。 URI PUT /v1/tasks/{task_id}/stop 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 参数解释: 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck
HE2E DevOps实践之代码检查 本文以“DevOps全流程示例项目”为例,介绍如何在项目中进完成代码检查配置。 预置任务简介 样例项目中预置了以下4个代码检查任务。 表1 预置任务 预置任务 任务说明 phoenix-codecheck-worker 检查Worker功能对应代码的任务
查询任务的高级配置 功能介绍 查询任务的高级配置 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/settings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID,
查看代码检查结果 为了确保代码质量,及时发现并修复潜在的问题,代码检查任务执行完成后,需及时查看代码检查结果。 前提条件 您已创建并执行代码检查任务。 查看代码检查详情 访问CodeArts Check服务首页。 进入代码检查页面,搜索目标任务。在任务列表页,可以查看检查任务的状态
查询任务执行状态 功能介绍 根据任务ID查询任务执行状态。任务状态:0表示检查中,1表示检查失败,2表示检查成功,3表示任务中止。只有正在检查中才有进度的详细信息。 调用方法 请参见如何调用API。 URI GET /v2/tasks/{task_id}/progress 表1 路径参数
错误码 调用接口出错后,将不会返回结果数据。调用方可根据每个接口对应的错误码来定位错误原因。 当调用出错时,如HTTP请求返回一个400或505的HTTP状态码。返回的消息体中是具体的错误代码及错误信息。 在调用方找不到错误原因时,可以联系华为云客服,并提供错误码,以便我们尽快帮您解决问题
查询任务规则集的检查参数v2 功能介绍 查询任务规则集的检查参数v2 调用方法 请参见如何调用API。 URI GET /v2/{project_id}/tasks/{task_id}/ruleset/{ruleset_id}/check-parameters 表1 路径参数 参数
执行检查任务 功能介绍 执行检查任务。 调用方法 请参见如何调用API。 URI POST /v2/tasks/{task_id}/run 表1 路径参数 参数 是否必选 参数类型 描述 task_id 是 String 参数解释: 任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck