anchore/sbom-action is one of the open-source repositories TopGit tracks, currently at 265 stars, written primarily in TypeScript. GitHub Action for creating software bill of materials using Syft.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
A GitHub Action for creating a software bill of materials (SBOM) using Syft.
Basic Usage
- uses: anchore/sbom-action@v0
By default, this action will execute a Syft scan in the workspace directory
and upload a workflow artifact SBOM in SPDX format. It will also detect
if being run during a GitHub release
and upload the SBOM as a release asset.
[!IMPORTANT]
To upload the SBOM to releases, you will need to give the action permission to read the artifact from the action, and write it to the release:
The image will be fetched using the Docker daemon if available,
which will use any authentication available to the daemon.
If the Docker daemon is not available, the action will retrieve the image
directly from the container registry.
It is also possible to directly connect to the container registry with the
registry-username and registry-password parameters. This will always bypass the
Docker daemon:
The sbom-action will detect being run during a
GitHub release
and automatically upload all SBOMs as release assets. However,
it may be desirable to upload SBOMs generated with other tools or using Syft
outside this action. To do this, use the anchore/sbom-action/publish-sbom sub-action
and specify a regular expression with the sbom-artifact-match
parameter:
[!IMPORTANT]
If using this action within a matrix build, you must specify a unique artifact-name
based on matrix parameters or the artifact upload will fail due to duplicate names. See
an example here.
Permissions
This action needs the following permissions, depending on how it is being used:
contents: write # for sbom-action artifact uploads
If attaching release assets, the actions: read permission is also required.
This may be implicit for public repositories, but is likely to be necessary for
private repositories.
actions: read # to find workflow artifacts when attaching release assets
Configuration
anchore/sbom-action
The main SBOM action, responsible for generating SBOMs
and uploading them as workflow artifacts and release assets.
Parameter
Description
Default
path
A path on the filesystem to scan. This is mutually exclusive to file and image.
<current directory>
file
A file on the filesystem to scan. This is mutually exclusive to path and image.
image
A container image to scan. This is mutually exclusive to path and file. See Scan a container image for more information.
registry-username
The registry username to use when authenticating to an external registry
registry-password
The registry password to use when authenticating to an external registry
artifact-name
The name to use for the generated SBOM artifact. See: Naming the SBOM output
sbom-<job>-<step-id>.spdx.json
output-file
The location to output a resulting SBOM
format
The SBOM format to export. One of: spdx, spdx-json, cyclonedx, cyclonedx-json
spdx-json
dependency-snapshot
Whether to upload the SBOM to the GitHub Dependency submission API
false
upload-artifact
Upload artifact to workflow
true
upload-artifact-retention
Retention policy in days for uploaded artifact to workflow.
upload-release-assets
Upload release assets
true
syft-version
The version of Syft to use
github-token
Authorized secret GitHub Personal Access Token.
github.token
config
Syft configuration file to use.
anchore/sbom-action/publish-sbom
A sub-action to upload multiple SBOMs to GitHub releases.
Parameter
Description
Default
sbom-artifact-match
A pattern to find SBOM artifacts.
.*\\.spdx\\.json$
anchore/sbom-action/download-syft
A sub-action to download Syft.
Parameter
Description
Default
syft-version
The version of Syft to download
Output parameters:
Parameter
Description
cmd
a reference to the Syft binary.
cmd can be referenced in a workflow like other output parameters:
${{ steps.<step-id>.outputs.cmd }}
Windows
This action is tested on Windows, and should work natively on Windows hosts
without WSL. (Note that it previously required WSL, but should now be run
natively on Windows.)
Diagnostics
This action makes extensive use of GitHub Action debug logging,
which can be enabled as described here
by setting a secret in your repository of ACTIONS_STEP_DEBUG to true.
No homepage URL was recorded for anchore/sbom-action in TopGit's last sync. The README tab above frequently contains screenshots and demo links, or check the repository description on GitHub.
Does anchore/sbom-action have any tags?
TopGit's last sync did not record any GitHub topics for anchore/sbom-action. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on anchore/sbom-action?
The most recent commit recorded on anchore/sbom-action was 11 days ago, based on the GitHub push timestamp. The repository has 49 forks — one of the better signals of community interest.
How many stars does anchore/sbom-action have?
anchore/sbom-action has 265 GitHub stars — refresh the page for the live number, or check github.com/anchore/sbom-action. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
Is anchore/sbom-action open source?
Yes — anchore/sbom-action ships under the Apache-2.0 license, which makes its source code freely readable (and, depending on license terms, forkable and reusable). Source: github.com/anchore/sbom-action.
Where do I read more about anchore/sbom-action?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/anchore/sbom-action is the definitive source.
Read full README in the tab above.
Want a second opinion on sbom-action?
Ask an AI that can read this page — one click and you get its take on sbom-action.