扫描方案
功能介绍
扫描方案由执行扫描任务的多个规则包所组成。方案内支持质量门禁的设置,度量规则的切换,路径过滤等功能。单次扫描方案可以在不同的扫描任务中重复使用,比如对于多个仓库里的不同 Java 分支,只需要配置一份 Java 相关的扫描方案即可复用。
新建扫描方案
进入【扫描方案】后点击蓝色的 +
号按钮就可以新建一个扫描方案。此时需要填写扫描方案的名称,勾选扫描语言并添加扫描规则包,根据语言需要编译配置情况。
扫描规则
代码检查将会通过预先设置好的规则集对源码进行扫描。通过规则包内含的词法分析、语法分析、控制流、数据流分析等技术对程序代码进行扫描分析,能够检查代码是否存在规范性、安全性、可靠性、可维护性、部分性能方面的问题。
系统预置了多个语言的规则包,若对推荐的规则包不满意,您可以在【扫描规则】里的扩展规则包中,点击【查看详细规则】进入规则包详情页,点击右上角添加规则。
对于现有规则包,您也可以进入任意规则包,对当前规则的参数以及严重级别进行调整。
质量门禁
质量门禁用于直观衡量当前代码质量是否满足预期的标准,辅助进行决策。比如是否允许和并请求并入分支,是否允许发布上线。您可以根据团队情况设置质量门禁的阈值,如果扫描出来的质量问题均低于阈值则视为通过质量门禁,否则视为不通过。
代码度量
在代码度量中,您可以根据团队的质量标准编辑代码度量所使用的规则,比如指定圈复杂度超标方法的标准,衡量重复代码的标准等。
路径过滤
用于设定代码分析的范围。设定后,已经开启的代码检查、代码度量的各项功能都会在指定的路径范围内生效。路径过滤规则如下:
include(包含) 表示只扫描,例如只需要扫描 src/
目录下文件,可以在目标路径中输入 src/*
。
exclude(过滤) 表示只屏蔽,如果要屏蔽 src/lib/
目录下的文件,可以在目标路径中输入 src/lib/*
,这样将会跳过该目录下的文件。
需要注意的是: exclude 设置优先级高于 include 。若路径重叠,将会执行 exclude(过滤)策略。
已关联的分支
此页面可以查看使用该扫描方案的代码仓库分支汇总。
方案属性
用于展示目前选中方案的基本属性,包含当前方案的名称以及方案的描述。
废弃扫描方案
对于不常用的扫描方案,您可以选择将其废弃,以提升挑选扫描方案的效率。
进入任一扫描方案,点击「方案属性」右下角的「废弃扫描方案」按钮。
系统内置的扫描方案不支持废弃操作。待废弃的扫描方案不可与扫描任务关联,若已有关联则需提前将任务关联至其他方案。
方案废弃后,在新建/编辑扫描任务的所有入口,选择扫描方案时已废弃方案均不可见。在扫描方案中您仍可以看到此扫描方案,并且支持编辑与恢复。
在阅读中是否遇到以下问题?
您希望我们如何改进?