Generating an SBOM for Ruby (Bundler)

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:

bundle install
npx @cyclonedx/cdxgen -t ruby -o sbom.json .

Produces:: sbom.json
Format:: CycloneDX JSON

Generator documentation

The whole CI job

GitHub Actions

- uses: actions/checkout@v4
- run: bundle install
- run: npx @cyclonedx/cdxgen -t ruby -o sbom.json .
- uses: mmalinowski/cradesk-action@v1
  with:
    sbom-path: sbom.json

GitLab CI/CD

generate-sbom:
  script:
    - bundle install
    - npx @cyclonedx/cdxgen -t ruby -o 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

Run bundle install first: the inventory is read from the resolved bundle, not from the Gemfile. cdxgen is used here because the older cyclonedx-ruby gem defaults to XML, which the scan refuses.

What CRA Desk does with the result

Components from this build carry pkg:gem package URLs, which the watch matches against OSV's RubyGems 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.

What we match, and what we deliberately do not Scope classifier