使用依赖项提交 API

可以使用 依赖项提交 API 来提交项目的依赖项，例如生成或编译项目时解析的依赖项。

本文内容

关于 依赖项提交 API

可以使用 REST API 提交项目的依赖项。 这使你可以将依赖项（如编译或生成软件时解析的依赖项）添加到 GitHub 的依赖项关系图功能，从而更全面地了解项目的所有依赖项。

依赖项关系图显示你使用 API 提交的任何依赖项，以及从存储库中的清单或锁定文件（例如 package-lock.json JavaScript 项目中的文件）标识的任何依赖项。 有关查看依赖项关系图的详细信息，请参阅 探索仓库的依赖项。

提交的依赖项将收到 Dependabot alerts 和 Dependabot security updates 以处理任何已知的漏洞。 你只会收到来自 GitHub Advisory Database 支持的生态系统之一的依赖关系的 Dependabot alerts。 有关这些生态系统的详细信息，请参阅 关于 GitHub 公告数据库。 对于通过 依赖项提交 API 提交的可传递依赖项，如果更新可用，Dependabot 将自动打开拉取请求以更新父依赖项。

提交的依赖项会显示在依赖项评审中，但在组织的依赖项见解中_不_可用。

注意

依赖关系审查 API 和 依赖项提交 API 协同工作。 这意味着依赖关系审查 API 将包括通过 依赖项提交 API 提交的依赖关系。

依赖项以快照的形式提交到 依赖项提交 API。 快照是一组与提交 SHA 和其他元数据关联的依赖项，反映提交存储库的当前状态。 可根据生成时检测到的依赖项或软件物料清单 (SBOM) 生成快照。 有 GitHub Actions 支持上述任一用例。 有关 依赖项提交 API 的详细信息，请参阅 适用于依赖项提交的 REST API 终结点。

在生成时提交依赖项

可以在 GitHub Actions 工作流中使用 依赖项提交 API，从而在生成项目时提交项目的依赖项。

使用预创建的操作

使用 依赖项提交 API 最简单的方法是向存储库添加预创建的操作，该操作将收集依赖项列表并将它转换为所需的快照格式，然后将此列表提交到 API。

有关这些操作的详细信息，请参阅 依赖项关系图支持的包生态系统。

创建自己的操作

你还可以编写你自己操作，以便在生成时提交项目的依赖项。 你的工作流应：

  1. 生成项目的依赖项列表。
  2. 将依赖项列表转换为 依赖项提交 API 接受的快照格式。 有关格式的详细信息，请参阅在 适用于依赖项提交的 REST API 终结点 中“创建仓库快照”API 终结点的正文参数。
  3. 将格式化的依赖项列表提交到 依赖项提交 API。

GitHub 将维护依赖项提交工具包，这是一个 TypeScript 库，可帮助你生成自己的 GitHub 操作，用于将依赖项提交到 依赖项提交 API。 有关编写操作的详细信息，请参阅 共享自动化。

生成和提交软件物料清单 (SBOM)

SBOM 是项目依赖项和相关信息（如版本、包标识符、许可证、支持可传递依赖标签的包生态系统的可传递路径，以及版权信息）的正式、机器可读清单。 SBOM 可通过以下方式帮助降低供应链风险：

  • 让仓库使用的依赖项公开透明
  • 支持跨代码库识别漏洞
  • 提供有关代码库中可能存在的许可证合规性、安全性或质量议题的见解
  • 使你能够更好地遵守各种数据保护标准

有关支持可传递依赖项标签的生态系统的详细信息，请参阅 依赖项关系图支持的包生态系统.

生成软件物料清单 (SBOM)

若要生成 SBOM，可以使用：

操作详细信息
Anchore SBOM 操作使用 Syft 通过受支持的生态系统创建与 SPDX 2.2 兼容的 SBOM
Microsoft 提供的 sbom-tool扫描依赖项并创建与 SPDX 兼容的 SBOM

将软件物料清单 (SBOM) 提交到 依赖项提交 API

要接收具有已知漏洞的任何依赖项的 Dependabot alerts，可以上传 SBOM 并将其提交到 依赖项提交 API。 要将 SBOM 提交到 依赖项提交 API，可以使用下表中的任意一项操作。

提示

SPDX 依赖项提交操作和定位点 SBOM 操作可用于生成 SBOM 并将其提交到 依赖项提交 API。

操作详细信息
SPDX 依赖项提交操作使用 Microsoft 的 SBOM 工具通过受支持的生态系统创建与 SPDX 2.2 兼容的 SBOM
Anchore SBOM 操作使用 Syft 通过受支持的生态系统创建与 SPDX 2.2 兼容的 SBOM
SBOM 依赖项提交操作将 CycloneDX SBOM 上传到 依赖项提交 API

例如，以下 SPDX 依赖项提交操作工作流将计算存储库的依赖项，生成 SPDX 2.2 格式的可导出的 SBOM，并将其提交到 依赖项提交 API。


name: SBOM upload

on:
  workflow_dispatch:
  push:
    branches: ["main"]

jobs:
  SBOM-upload:

    runs-on: ubuntu-latest
    permissions:
      id-token: write
      contents: write

    steps:
    - uses: actions/checkout@v4
    - name: Generate SBOM
      # generation command documentation: https://github.com/microsoft/sbom-tool#sbom-generation
      run: |
        curl -Lo $RUNNER_TEMP/sbom-tool https://github.com/microsoft/sbom-tool/releases/latest/download/sbom-tool-linux-x64
        chmod +x $RUNNER_TEMP/sbom-tool
        $RUNNER_TEMP/sbom-tool generate -b . -bc . -pn $ -pv 1.0.0 -ps OwnerName -nsb https://sbom.mycompany.com -V Verbose
    - uses: actions/upload-artifact@v4
      with:
        name: sbom
        path: _manifest/spdx_2.2
    - name: SBOM upload
      uses: advanced-security/spdx-dependency-submission-action@5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4e
      with:
        filePath: "_manifest/spdx_2.2/"