Skip to content

Latest commit

 

History

History
40 lines (31 loc) · 2.98 KB

File metadata and controls

40 lines (31 loc) · 2.98 KB
title Exporting a software bill of materials for your repository
intro You can export a software bill of materials or SBOM for your repository from the dependency graph. SBOMs allow transparency into your open source usage and help expose supply chain vulnerabilities, reducing supply chain risks.
versions
fpt ghes ghec
*
*
*
permissions {% data reusables.permissions.dependency-graph-export-sbom %}
shortTitle Export dependencies as SBOM
redirect_from
/code-security/supply-chain-security/understanding-your-software-supply-chain/exporting-a-software-bill-of-materials-for-your-repository
contentType how-tos
category
Secure your dependencies

You can export the current state of the dependency graph for your repository as a software bill of materials (SBOM) using the industry standard SPDX format.

SBOMs include an inventory of a project's dependencies and associated information such as {% ifversion ghes %}versions and package identifiers{% else %}versions, package identifiers, licenses, transitive paths, and copyright information{% endif %}. SBOMs do not include dependents (other projects that rely on your project).

Exporting a software bill of materials for your repository from the UI

{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %}

  1. In the left sidebar, click Dependency graph.
  2. On the top right side of the Dependencies tab, click Export SBOM to generate an SBOM file for download from your browser.

Exporting a software bill of materials for your repository using the REST API

If you want to use the REST API to export an SBOM for your repository, see AUTOTITLE.

Generating a software bill of materials from {% data variables.product.prodname_actions %}

The following actions will generate an SBOM for your repository and attach it as a workflow artifact which you can download and use in other applications. For more information about downloading workflow artifacts, see AUTOTITLE.

Action Details
SPDX Dependency Submission Action Uses Microsoft's SBOM Tool to create SPDX 2.2 compatible SBOMs with the supported ecosystems
Anchore SBOM Action Uses Syft to create SPDX 2.2 compatible SBOMs with the supported ecosystems
SBOM Dependency Submission Action Uploads a CycloneDX SBOM to the {% data variables.dependency-submission-api.name %}