Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
play

GitHub Action

CycloneDX GoMod Generate SBOM

v0.1.0

CycloneDX GoMod Generate SBOM

play

CycloneDX GoMod Generate SBOM

Github action to generate a CycloneDX SBOM for Go modules

Installation

Copy and paste the following snippet into your .yml file.

              

- name: CycloneDX GoMod Generate SBOM

uses: CycloneDX/gh-gomod-generate-sbom@v0.1.0

Learn more about this action in CycloneDX/gh-gomod-generate-sbom

Choose a version

gh-gomod-generate-sbom

GitHub action to generate a CycloneDX SBOM for Go modules.

This action uses cyclonedx-gomod to generate SBOMs.

Inputs

include-stdlib

Include Go standard library as component and dependency of the module. Default false.

include-test

Include test dependencies. Default false.

json

Output in JSON format. Default false.

module

Path to Go module. Default '.'.

omit-serial-number

Omit serial number. Default false.

omit-version-prefix

Omit "v" version prefix. Default false.

output

Output path. Default '-' (stdout).

reproducible

Make the SBOM reproducible by omitting dynamic content. Default false.

resolve-licenses

Resolve module licenses. Default false.

type

Type of the main component. Default 'application'.

version

Required The version of cyclonedx-gomod to use.

Example usage

- name: Generate SBOM JSON
  uses: CycloneDX/gh-gomod-generate-sbom@main
    with:
      json: true
      output: bom.json
      resolve-licenses: true
      version: 0.8.1

- name: Generate SBOM XML
  uses: CycloneDX/gh-gomod-generate-sbom@main
    with:
      output: bom.xml
      resolve-licenses: true
      version: 0.8.1