Plugin Documentation

This report describes goals, parameters details, requirements and sample usage of this plugin.

Goals

Goals available for this plugin:

Goal Description
sbom-enforcer:check Performs a configurable set of checks on the SBOMs attached to the build.

See Rules for a list of available rules.

System Requirements

The following specifies the minimum requirements to run this Maven plugin:

Maven 3.9.9
JDK 17

System Requirements History

The following specifies the minimum requirements to run this Maven plugin for historical versions:

Plugin Version Maven JDK
0.1.0 - -

Usage

You should specify the version in your project's plugin configuration:

<project>
  ...
  <build>
    <!-- To define the plugin version in your parent POM -->
    <pluginManagement>
      <plugins>
        <plugin>
          <groupId>io.github.sbom-enforcer</groupId>
          <artifactId>sbom-enforcer-maven-plugin</artifactId>
          <version>0.1.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>io.github.sbom-enforcer</groupId>
        <artifactId>sbom-enforcer-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
</project>

For more information, see "Guide to Configuring Plug-ins"