Plugin Documentation

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

Goals

Goals available for this plugin:

Goal	Report?	Description
apache-rat:check	No	Run Rat to perform a violation check. This documentation mentions data types for some of the arguments. An explanation of the data types is included in this documentation package.
apache-rat:help	No	Display help information on apache-rat-plugin. Call `mvn apache-rat:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.
apache-rat:rat	Yes	Generates a report with Rat's output.

System Requirements

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

Maven	3.2.5
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 0.16 to 0.16.1	3.2.5	8
from 0.14 to 0.15	2.2.1	8
from 0.9 to 0.13	2.2.1	5
from 0.6 to 0.8	2.0.4	1.4

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

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