| 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 |
|
||||||
| permissions | {% data reusables.permissions.dependency-graph-export-sbom %} | ||||||
| shortTitle | Export dependencies as SBOM | ||||||
| redirect_from |
|
||||||
| contentType | how-tos | ||||||
| category |
|
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).
{% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.accessing-repository-graphs %}
- In the left sidebar, click Dependency graph.
- On the top right side of the Dependencies tab, click Export SBOM to generate an SBOM file for download from your browser.
If you want to use the REST API to export an SBOM for your repository, see AUTOTITLE.
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 %} |