Generating an SBOM for JavaScript / TypeScript (npm)

The step below writes a CycloneDX JSON file in your own pipeline. The CRA Desk scan reads that file and turns it into a readiness report - it never generates one for you.

Run in CI:

npm ci
npm sbom --sbom-format cyclonedx --omit dev > sbom.json

Produces:

sbom.json

Format:

CycloneDX JSON

The whole CI job

- uses: actions/checkout@v4
- run: npm ci
- run: npm sbom --sbom-format cyclonedx --omit dev > sbom.json
- uses: mmalinowski/cradesk-action@v1
  with:
    sbom-path: sbom.json

generate-sbom:
  script:
    - npm ci
    - npm sbom --sbom-format cyclonedx --omit dev > sbom.json

include:
  - component: gitlab.com/cradesk/scan/readiness@1
    inputs:
      sbom_path: sbom.json

Only the first step changes with your stack - the CRA Desk step after it is identical everywhere.

What goes wrong here

npm sbom needs an installed tree, so npm ci has to run first. Omitting --omit dev puts your build tooling in the inventory and every advisory against it in your report.

What CRA Desk does with the result

Components from this build carry pkg:npm package URLs, which the watch matches against OSV's npm advisories when the SBOM arrives and again as new advisories land. Matching runs on every plan; e-mail alerts and the full match list are what a paid plan adds.

A generator that runs is not the same as coverage. Components with no purl, no version, or from an ecosystem outside the nine we watch are counted as gaps in every report rather than reported as clean.