Fork me on GitHub

Plugin Documentation

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

Goals

Goals available for this plugin:

Goal Report? Description
spotbugs:check No No description.
spotbugs:gui No No description.
spotbugs:help No Display help information on spotbugs-maven-plugin.
Call mvn spotbugs:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
spotbugs:spotbugs Yes No description.
spotbugs:verify No No description.

System Requirements

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

Maven 3.6.3
JDK 1.8

System Requirements History

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

Plugin Version Maven JDK
from 4.8.4.0 to 4.8.5.0 3.6.3 8
from 4.4.2.1 to 4.8.3.1 3.3.9 8
from 4.0.0 to 4.4.2 3.2.5 8
from 3.1.2 to 3.1.12.2 3.1.1 8
from 3.1.0 to 3.1.1 3.0.1 8
from 3.1.0-RC5 to 3.1.0-RC8 3.0.1 7

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>com.github.spotbugs</groupId>
          <artifactId>spotbugs-maven-plugin</artifactId>
          <version>4.8.5.0</version>
        </plugin>
        ...
      </plugins>
    </pluginManagement>
    <!-- To use the plugin goals in your POM or parent POM -->
    <plugins>
      <plugin>
        <groupId>com.github.spotbugs</groupId>
        <artifactId>spotbugs-maven-plugin</artifactId>
      </plugin>
      ...
    </plugins>
  </build>
  ...
  <!-- To use the report goals in your POM or parent POM -->
  <reporting>
    <plugins>
      <plugin>
        <groupId>com.github.spotbugs</groupId>
        <artifactId>spotbugs-maven-plugin</artifactId>
        <version>4.8.5.0</version>
      </plugin>
      ...
    </plugins>
  </reporting>
  ...
</project>

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