先决条件
要使此处描述的存储库属性生效,您需要配置 code scanning。 请参阅“关于代码扫描的设置类型”。
必须为组织手动创建影响 code scanning 的存储库属性。 然后,可以为它们设置应用于整个组织的值,或者允许为每个存储库单独配置这些值。 请参阅“管理组织中存储库的自定义属性”。
code scanning 支持的存储库属性
某些 code scanning 功能可以通过代码库属性进行配置。 组织可以使用存储库属性跨所有存储库和单个存储库强制实施配置。 如果 code scanning 是使用存储库属性自定义的,则自定义将应用于所有设置类型。
下面是可以设置的存储库属性概述,这些属性会影响 code scanning 配置时的分析:
| 名称 | 类型 |
|---|---|
github-codeql-extra-queries | 文本 |
github-codeql-disable-overlay | True/false |
github-codeql-file-coverage-on-prs | True/false |
注意
支持的存储库属性视您在 code scanning 分析中使用的 github/codeql-action 版本而定。 对于 code scanning 的高级设置,请检查您的工作流是否引用了最新的主要版本。 Code scanning 的默认设置会自动使用最新版本。
分析自定义
使用该 github-codeql-extra-queries 属性可以配置应运行的其他查询。 这对于向组织中的所有相关分析添加查询非常有用,无需修改单个工作流或切换到高级设置。 这接受与 queries 的输入相同的值。 请参阅“代码扫描的工作流配置选项”。
启用或禁用功能
可以通过将属性设置为 github-codeql-disable-overlay 来禁用改进的true增量分析。 如果由于硬件要求增加而改进的增量分析失败,这可能很有用。
不计算文件覆盖率信息以分析拉取请求。 如果要为拉取请求启用文件覆盖信息,可以将 github-codeql-file-coverage-on-prs 属性设置为 true。