先决条件
要使此处描述的仓库属性生效,您需要先设置代码扫描。参见 关于代码扫描的设置类型。
影响代码扫描的仓库属性必须由您的组织手动创建。然后,您可以为它们设置适用于整个组织的值,或允许为每个仓库单独配置。参见 在组织中管理仓库的自定义属性。
受支持的代码扫描仓库属性
某些代码扫描功能可以通过仓库属性进行配置。组织可以使用仓库属性对所有仓库或单个仓库强制执行配置。如果使用仓库属性自定义代码扫描,则自定义适用于所有设置类型。
以下是您可以设置的、在配置后影响代码扫描分析的仓库属性概览
| 名称 | 类型 |
|---|---|
github-codeql-extra-queries | Text |
github-codeql-disable-overlay | True/false |
github-codeql-file-coverage-on-prs | True/false |
注意
受支持的仓库属性取决于您代码扫描分析使用的 github/codeql-action 的版本。对于代码扫描高级设置,请确保您的工作流引用的是最新的主要版本。代码扫描默认设置会自动使用最新版本。
分析自定义
github-codeql-extra-queries 属性允许您配置应运行的额外查询。这对于在组织中的所有相关分析中添加查询,而无需修改各个工作流或切换到高级设置,非常有用。此属性接受与 github/codeql-action 的 queries 输入相同的值。参见 代码扫描的工作流配置选项。
启用或禁用功能
您可以通过将 github-codeql-disable-overlay 属性设置为 true 来禁用改进的增量分析。如果由于硬件需求增加导致改进的增量分析失败,这可能会有帮助。
对拉取请求的分析不会计算文件覆盖信息。如果您想为拉取请求启用文件覆盖信息,可以将 github-codeql-file-coverage-on-prs 属性设置为 true。