SBOM

Generate SBOMs for artifacts (assemblers & distributions) as well as files.

Configuration

Legend:

  • required

  • optional

  • may use environment variable

  • accepts Name Templates

  • YAML

  • TOML

  • JSON

  • Sbom

  • Gradle

# 
catalog:
  sbom:
    # Enable or disable all configured catalogers.
    # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
    # Defaults to `ALWAYS`.
    #  
    active: ALWAYS
# 
[catalog.sbom]

  # Enable or disable all configured catalogers.
  # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
  # Defaults to `ALWAYS`.
  #  
  active = "ALWAYS"
{
  // 
  "catalog": {
    "sbom": {
      // Enable or disable all configured catalogers.
      // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
      // Defaults to `ALWAYS`.
      //  
      "active": "ALWAYS"
    }
  }
}
<jreleaser>
  <!--
    
  -->
  <catalog>
    <sbom>
      <!--
        Enable or disable all configured catalogers.
        Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
        Defaults to `ALWAYS`.
         
      -->
      <active>ALWAYS</active>
    </sbom>
  </catalog>
</jreleaser>
jreleaser {
  // 
  catalog {
    sbom{
      // Enable or disable all configured catalogers.
      // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
      // Defaults to `ALWAYS`.
      //  
      active = 'ALWAYS'
    }
  }
}

Environment

When not explicitly set, the value of the following properties may be resolved from an environment variable or a system property as shown in the table. The system property takes precedence over the environment variable.

System Property Environment Variable

active

jreleaser.catalog.sbom.active

JRELEASER_CATALOG_SBOM_ACTIVE