Skip to main content

Enterprise Server 3.20 目前作为发布候选版本提供。

使用工具状态页进行代码扫描

查看实时工具状态、识别配置问题并下载报告,使 code scanning 分析顺利运行。

谁可以使用此功能?

具有写入访问权限的用户

Code scanning 可用于以下存储库类型:

  • GitHub.com 上的公共存储库
  • GitHub Team、GitHub Enterprise Cloud 或 GitHub Enterprise Server 上的组织拥有的存储库,已启用 GitHub Code Security

注意

网站管理员必须启用 code scanning,然后你才能使用此功能。 有关详细信息,请参阅“为设备配置代码扫描”。

如果企业所有者在企业级别设置了 GitHub Code Security 策略,则你可能无法启用或禁用 code scanning。 有关详细信息,请参阅“强制实施企业的代码安全性和分析策略”。

工具状态页 显示了有关所有代码扫描工具的信息,是调试问题的良好起点。 有关该工具及其提供的信息的详细信息,请参阅 关于工具状态页面

查看存储库的 工具状态页

每个存储库的 code scanning 警报页都包含一个工具横幅,其中包含代码扫描分析的运行状况摘要,并且可以访问 工具状态页 以浏览设置。

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

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

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

  3. 在左边栏中,单击“ Code scanning”****。

  4. 单击工具横幅中的“工具状态”****。

           ![显示如何从存储库访问工具状态页的屏幕截图。 “工具状态”按钮以深橙色边框突出显示。](/assets/images/help/repository/code-scanning-tool-status-page-access.png)
    

使用 工具状态页

在 工具状态页 中,你将看到某一个工具的摘要,并在边栏中突出显示。 可以使用边栏查看不同工具的摘要。

屏幕截图显示工具状态页,其中选择了 CodeQL 工具。

对于 CodeQL 等集成工具,可以查看存储库中最近扫描的所有文件的总百分比(按编程语言分类)。 还可以下载 CSV 格式的详细语言报表。 请参阅 下载分析的文件的详细信息

访问有关工具的详细信息

如果想查看当前显示工具的更多详细信息,可以在“设置类型”下选择特定设置。

在屏幕左侧的“配置”下,可以看到按此设置类型运行的每个分析的信息,以及任何相关的错误消息。 要查看有关最近分析运行的详细信息,请在边栏中选择一个配置。 可以下载详细信息,了解在该代码扫描中具体运行了哪些规则,以及每个规则发现的警报数。 有关详细信息,请参阅下载使用的规则列表

在工具状态页面中显示有关 CodeQL 的详细信息的屏幕截图。

此视图还将显示错误消息。 有关详细信息,请参阅使用工具状态页进行调试

下载已分析文件的详细信息

对于 CodeQL 等集成工具,可以从 工具状态页 下载 CSV 格式的详细报表。 这会显示:

  • 用于扫描每个文件的配置
  • 文件路径
  • 文件的编程语言
  • 文件是否已成功提取

要下载报表,请选择一个感兴趣的工具。 然后在页面右上角,单击 按钮。

下载使用的规则列表

可以 CSV 格式下载 code scanning 正在检查的规则列表。 这会显示:

  • 所使用的配置
  • 规则源
  • SARIF 标识符
  • 已找到的警报数

要下载报表,请选择一个感兴趣的配置。 然后,单击页面右上角的“”,选择“ Download list of rules used”********。

删除配置

可以删除存储库默认分支的过时、重复或不需要的配置。

要删除配置,请选择要删除的配置。 然后,单击页面右上角的“”,选择“ Delete configuration”********。 阅读完有关警报的警告后,要确认删除,请单击“删除”**** 按钮。

注意

只能使用 工具状态页 删除存储库默认分支的配置。 有关从非默认分支删除配置的信息,请参阅 解决代码扫描警报

使用工具状态页进行调试

如果在 code scanning 警报页发现分析存在问题,可以使用 工具状态页 来识别问题。 对于集成工具,可以在详细信息部分查看与特定 code scanning 工具相关的特定错误消息。 这些错误消息包含有关工具未按预期执行的原因以及你可以采取的措施的信息。 有关如何访问 工具状态页 此部分的详细信息,请参阅访问有关工具的详细信息

对于 CodeQL 等集成工具,还可以使用文件覆盖率信息来改进分析。 有关解释文件覆盖率百分比的详细信息,请参阅 关于工具状态页面

有关详细信息,请参阅 代码扫描分析错误疑难解答排查 SARIF 上传问题