Clirr Maven Plugin – Plugin Documentation

Plugin Documentation

Goals available for this plugin:

Goal	Report?	Description
clirr:check	No	Check for compatibility with previous version.
clirr:check-arbitrary	No	Check for compatibility between two arbitrary artifact sets.
clirr:check-no-fork	No	Check for compatibility with previous version without forking the project
clirr:clirr	Yes	Generate a report from the Clirr output.
clirr:help	No	Display help information on clirr-maven-plugin. Call `mvn clirr:help -Ddetail=true -Dgoal=<goal-name>` to display parameter details.

System Requirements

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

Maven	2.0.6
JDK	1.7
Memory	No minimum requirement.
Disk Space	No minimum requirement.

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

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