我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

鉴定拉取请求中的代码扫描警报

当 代码扫描 在拉取请求中发现问题时,您可以审查高亮的代码并解决警报。

If you have read permission for a repository, you can see annotations on pull requests. With write permission, you can see detailed information and resolve 代码扫描 alerts for that repository.

代码扫描 在您拥有 GitHub Advanced Security 的许可证时可用。

本文内容

注: 代码扫描 正在测试用于 GitHub Enterprise Server 2.22。 对于代码扫描的一般可用版本,请升级到最新版本的 GitHub Enterprise Server。

关于拉取请求上的 代码扫描 结果

在仓库中,如果 代码扫描 被配置为拉取请求检查,则 代码扫描 将检查拉取请求中的代码。 默认情况下,这仅限于针对默认分支的拉取请求,但是您可以在 GitHub Actions 或第三方 CI/CD 系统中更改此配置。 如果合并分支给目标分支带来新的 代码扫描 警报,这些警报将在拉取请求中被报告为检查结果。 警报还将在拉取请求的 Files changed(文件已更改)选项卡中显示为注释。 如果您拥有仓库的写入权限,您可以在 Security(安全)选项卡中查看任何现有的 代码扫描 警报。 有关仓库警报的更多信息,请参阅“管理仓库的 代码扫描 警报”。

如果 代码扫描 有任何严重性为 error 的结果,则检查失败,错误将报告在检查结果中。 如果 代码扫描 发现的所有结果的严重性都较低,则警报将被视为警告或通知,检查成功。 如果拉取请求针对使用 代码扫描 的受保护分支,并且仓库所有者配置了必需状态检查,则您必须修复或关闭所有错误警报,然后才能合并拉取请求。 更多信息请参阅“关于受保护分支”。

拉取请求上失败的 代码扫描 检查

关于 代码扫描 作为拉取请求检查

有许多选项可将 代码扫描 配置为拉取请求检查,因此每个仓库的确切设置会有所不同,有些仓库还会有多个检查。 包含 代码扫描 结果的检查为:代码扫描结果

如果仓库使用 CodeQL 分析工作流程,则在结果检查运行之前,将针对每种语言运行 CodeQL / Analyze (LANGUAGE) 检查。 如果存在配置问题,或者拉取请求中断了分析需要编译的语言(例如 C/C ++、C# 或 Java)的构建,则分析检查可能会失败。 与其他拉取请求检查一样,您可以在 Checks(检查)选项卡上查看检查失败的完整细节。 有关配置和故障排除的详细信息,请参阅“配置 代码扫描”或“排查 CodeQL 工作流程故障”。

鉴定拉取请求上的警报

查看拉取请求的 Files changed(文件已更改)选项卡时,您会看到任何触发警报的代码行的注释。

拉取请求差异中的警报注释

如果您拥有仓库的写入权限,则某些注释将包含警报额外上下文的链接。 在上例中,您可以在 CodeQL 分析中单击 user-provided value(用户提供的值),以查看不受信任的数据进入数据流的位置(这被称为源)。 在此例中,您还可以通过单击 Show paths(显示路径)来查看从源到使用数据的代码(池)的完整路径。 这样就很容易检查数据是否不受信任,或者分析是否无法识别源与池之间的数据净化步骤。 有关使用 CodeQL 分析数据流的信息,请参阅“关于数据流分析”。

要查看有关警报的更多信息,拥有写入权限的用户可单击注释中所示的 Show more details(显示更多详情)链接。 这允许您在警报视图中查看工具提供的所有上下文和元数据。 在下例中,您可以查看显示问题的严重性、类型和相关通用缺陷枚举 (CWE) 的标记。 该视图还显示哪个提交引入了问题。

在警报的详细视图中,有些 代码扫描 工具,例如 CodeQL 分析,还包括问题描述和 Show more(显示更多)链接以指导您如何修复代码。

显示更多信息的警报说明和链接

解决拉取请求上的警报

任何对拉取请求具有推送权限的人都可以修复在该拉取请求上已识别的 代码扫描 警报。 如果将更改提交到拉取请求,这将触发拉取请求检查的新运行。 如果您的更改修复了问题,则警报将被关闭,注释将被删除。

如果您认为警报不需要修复,则具有写入权限的用户可以手动关闭警报。 例如,仅用于测试的代码中有错误,或者修复错误的工作超过改进代码的潜在益处。 如果您对仓库有写入权限,则 Close(关闭)按钮在注释和警报视图中可用。

如果将 CodeQL 警报作为误报予以关闭,例如,因为代码使用不受支持的净化库,则考虑参与 CodeQL 仓库并改进分析。 有关 CodeQL 的更多信息,请参阅“参与 CodeQL”。

此文档对您有帮助吗?

Privacy policy

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。