Built by Maven

Plugin Documentation

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

Goals

Goals available for this plugin:

Goal Report? Description
plugin-report:help No Display help information on maven-plugin-report-plugin.
Call mvn plugin-report:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
plugin-report:report Yes Generates the Plugin's documentation report: plugin-info.html plugin overview page, and one goal-mojo.html per goal. Relies on one output file from plugin:descriptor.
plugin-report:report-no-fork Yes Generates the Plugin's documentation report: plugin-info.html plugin overview page, and one goal-mojo.html per goal. Relies on one output file from plugin:descriptor.

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
4.0.0-beta-1 3.6.3 -
from 3.13.0 to 3.14.0 3.6.3 8
from 3.7.0 to 3.12.0 3.2.5 8

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

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