工具状态页是什么?
工具状态页 显示了所有 code scanning 工具的信息,是调试 code scanning 未按预期工作时问题的良好起点。
注意
工具状态页 仅显示默认分支在存储库级别的工具状态,而不是在组织级别。
工具状态指示器
工具状态页 会显示三种状态中的一种:
- 所有配置都正常工作:所有工具都按预期运行
- 某些配置需要注意:某些工具存在警告或非严重问题
- 某些配置不起作用:一个或多个工具存在严重错误
哪些信息可用
对于所有 code scanning 工具
- 配置状态和运行状况
- 扫描计划
- 首次和最新的扫描时间
- 扫描中使用的规则
对于集成工具,例如 CodeQL
除了上面列出的信息之外,集成工具的 工具状态页 还提供以下详细信息:
- 按编程语言的文件覆盖率百分比
- 每种安装类型的配置详细信息
- 特定错误消息
- 已分析文件的可下载 CSV 报告
- 已使用规则和警报计数的可下载列表
CodeQL 如何定义已扫描的文件
如果文件中的某些代码行已被处理,则 CodeQL 将该文件报告为已扫描。
解释型语言
- 默认设置:扫描的文件包括可以分析的语言 CodeQL 的所有源代码文件
- 高级设置:可以使用
paths和paths-ignore定义要扫描的文件。 请参阅“关于使用 CodeQL 进行代码扫描”。
已编译的语言
工具状态页 报告在运行自动生成或手动生成步骤之前存在的文件。 不会显示生成过程中生成的文件。 请参阅“对编译语言进行 CodeQL 代码扫描”。
覆盖率计算
文件覆盖率百分比考虑任何由 paths 和 paths-ignore 配置属性排除的文件。
了解文件覆盖率百分比
使用文件覆盖率百分比调试和改进分析:
- 百分比比较高:Code scanning 正在按预期使用该语言
- 低百分比:调查诊断结果。 请参阅“CodeQL 扫描的行数少于预期”
- 零百分比:你可能有用当前未被分析的语言编写的代码。 更新设置以包含这些语言。 请参阅“代码扫描的工作流配置选项”
注意
如果您同时设置了高级设置和默认设置,则工具状态页 将仅显示默认设置。
故障排除功能
工具状态页 可通过以下方式帮助你解决问题:
- 错误消息:解释工具未按预期方式执行的原因,并提供建议操作
- 文件覆盖率数据:显示正在分析哪些文件和语言
- 配置详细信息:显示有关每个分析任务的信息
- 可下载报表:提供包含详细文件和规则信息的 CSV 报告