# 存储库属性 code scanning

可以使用存储库属性来 code scanning 调整以满足你的需求。

## 先决条件

要使此处所述的存储库属性生效，需要设置 code scanning。 请参阅“[关于代码扫描的设置类型](/zh/enterprise-server@3.22/code-security/concepts/code-scanning/setup-types)”。

必须为组织手动创建影响 code scanning 存储库属性。 然后，可以为它们设置应用于整个组织的值，或者允许为每个存储库单独配置这些值。 请参阅“[管理组织中存储库的自定义属性](/zh/enterprise-server@3.22/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)”。

## 在应用更改之前测试更改

在向整个组织推出配置之前，你可能希望测试通过存储库属性应用的配置是否具有所需的效果。 可以将存储库属性设置为各个存储库的特定值。 如果首次配置存储库属性，请为组织创建它，但不要将其设置为值。 而是将其设置为特定测试存储库的值，可在其中首先验证更改。 在测试存储库上验证后，可以为整个组织或所需的存储库设置值。

更改支持的存储库属性的值时，可以使用相同的方法。 重写或设置测试存储库的存储库属性的值，验证更改，然后将其推出到组织或其他存储库。

## 支持的存储库属性 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 |

> \[!NOTE]
> 支持的存储库属性取决于分析使用的 [](https://github.com/github/codeql-action/)code scanning 版本。 对于 code scanning 高级设置，请检查工作流是否引用了最新的主版本。
> Code scanning 默认设置自动使用最新版本。 如果正在运行 GitHub Enterprise Server 的服务器未连接到 Internet，则可能需要使用 CodeQL 操作同步工具。 请参阅 [为设备配置代码扫描](/zh/enterprise-server@3.22/code-security/how-tos/secure-at-scale/configure-enterprise-security/configure-specific-tools/configuring-code-scanning-for-your-appliance#configuring-codeql-analysis-on-a-server-without-internet-access)。

### 分析自定义

使用该 `github-codeql-extra-queries` 属性可以配置应运行的其他查询。 这对于向组织中的所有相关分析添加查询非常有用，无需修改单个工作流或切换到高级设置。 这接受与 `queries` 的输入相同的值[](https://github.com/github/codeql-action/)。 请参阅“[代码扫描的工作流配置选项](/zh/enterprise-server@3.22/code-security/reference/code-scanning/workflow-configuration-options)”。

### 启用或禁用功能

可以通过将属性设置为 `github-codeql-disable-overlay` 来禁用改进的`true`增量分析。 如果由于硬件要求增加而改进的增量分析失败，这可能很有用。

对于拉取请求的分析，不计算文件覆盖信息。 如果要为拉取请求启用文件覆盖信息，可以将 `github-codeql-file-coverage-on-prs` 属性设置为 `true`。