Skip to main content

SPDX

SpdxDocument

Creates software bills of materials (SBOM) in the SPDX format.

Configuration​

Example​

Use the following syntax to configure this plugin globally as part of config.yml:

ort:
  reporter:
    reporters:
      SpdxDocument:
        options:
          creationInfoComment: null
          creationInfoPerson: null
          creationInfoOrganization: null
          documentComment: null
          documentName: "Unnamed document"
          outputFileFormats: "YAML"
          fileInformationEnabled: true

Options​

creationInfoComment​

STRING

The comment to add to the [SpdxDocument.creationInfo].

creationInfoPerson​

STRING

The person to add to the [SpdxDocument.creationInfo].

creationInfoOrganization​

STRING

The organization to add to the [SpdxDocument.creationInfo].

documentComment​

STRING

The comment to add to the [SpdxDocument].

documentName​

STRING ![Default](https://img.shields.io/badge/Default-Unnamed document-darkgreen)

The name of the generated [SpdxDocument].

outputFileFormats​

STRING_LIST Default

The list of file formats to generate. Supported values are "YAML" and "JSON".

fileInformationEnabled​

BOOLEAN Default

Toggle whether the output document should contain information on file granularity about files containing findings.