Skip to main content

编辑默认设置配置

你可以编辑 code scanning 的现有默认设置配置,以更好地满足代码安全需求。

Code scanning 可用于 GitHub.com 上的所有公共存储库。 Code scanning 也可用于使用 GitHub Enterprise Cloud 并拥有 GitHub Advanced Security 许可证的组织所拥有的专用存储库。 有关详细信息,请参阅“关于 GitHub 高级安全性”。

编辑默认设置配置的简介

使用默认设置运行代码初始分析后,可能需要对配置进行更改,以便更好地满足代码安全需求。 对于现有默认设置配置,可以编辑 :

  • 语言默认设置会进行分析。
  • 查询套件在分析期间运行。 有关可用查询套件的详细信息,请参阅“内置 CodeQL 查询套件”。

如果代码库依赖于 CodeQL 中包含的标准库无法识别的库或框架,则也可以使用 CodeQL 模型包在默认设置中扩展 CodeQL 覆盖范围。 有关详细信息,请参阅“在默认设置中使用 CodeQL 模型包扩展 CodeQL 覆盖范围”。

如果需要更改 code scanning 配置的任何其他方面,请考虑配置高级设置。 有关详细信息,请参阅“配置代码扫描的高级设置”。

自定义现有默认设置配置

  1. 在 GitHub.com 上,导航到存储库的主页。

  2. 在存储库名称下,单击 “设置”。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”********。

    存储库标头的屏幕截图,其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在边栏的“安全性”部分中,单击“ 代码安全性和分析”。

  4. 在“Code scanning”部分的“CodeQL 分析”行旁边,选择 ,然后单击 “查看 CodeQL 配置”。****

  5. 在“CodeQL 默认配置”窗口中,单击 “编辑”****。

  6. (可选)在“语言”部分中,选择或取消选择用于分析的语言。

  7. (可选)在“查询套件”部分中,选择要针对代码运行的其他查询套件。

  8. 要更新配置,并使用新配置运行对代码初始分析,请单击“保存更改”。**** 将来的所有分析都将使用新配置。

在默认设置中使用 CodeQL 模型包扩展 CodeQL 覆盖范围

注意:模型包目前为 beta 版,可能会发生更改。**** 在处于 beta 版期间,模型包仅受 Java 分析支持。

如果使用 CodeQL 中包含的标准库无法识别的框架和库,则可以对依赖项进行建模并扩展 code scanning 分析。 有关详细信息,请参阅 CodeQL 文档中的“支持的语言和框架”。

对于默认设置,需要在存储库中的 CodeQL 模型包中定义其他依赖项的模型。 有关 CodeQL 模型包和编写自己的模型包的详细信息,请参阅 CodeQL 文档中的“使用 CodeQL 模型编辑器”。

要使用具有默认设置的 CodeQL 模型包,请将它们放在 .github/codeql/extensions 目录中。 这些模型包将在 code scanning 分析中自动检测和使用。 如果以后将配置更改为使用高级设置,则 .github/codeql/extensions 目录中的任何数据扩展也将被识别和使用。