Plugin Documentation

Goals available for this plugin:

Goal Report? Description
revapi:check No Runs the API check of old and new artifacts using the specified configuration of extensions declared as dependencies of the plugin.
revapi:check-fork No No description.
revapi:convert-config-to-xml No This is a helper goal to convert the old JSON Revapi configuration inside the POM files into the new XML based format. You usually need to run this goal just once in each module.

Note that this does not touch the external configuration files. The old and new style configuration still works together well, though.

Note that this goal changes the contents of pom.xml of the built modules. You are advised to check the modifications for correctness and to update the formatting of the changed lines to your liking.

revapi:help No Display help information on revapi-maven-plugin.
Call mvn revapi:help -Ddetail=true -Dgoal=<goal-name> to display parameter details.
revapi:report Yes No description.
revapi:report-aggregate Yes Uses the configuration supplied at the top level aggregator project to run analysis on all sub-projects.

The artifacts to compare are taken from the configurations of the child projects while the configuration of Revapi and the extensions to use are taken from the aggregator project. The analyses are run in succession using a single instance of Revapi. Therefore you need to configure your custom Revapi reporter(s) to somehow not overwrite their reports, but append to it. The default site page generator can do this and the revapi-reporter-text reporter has an append boolean parameter for this. If you're using some other reporter, consult its documentation on how to append to a report instead of overwriting it.

revapi:report-fork Yes No description.
revapi:update-release-properties No No description.
revapi:update-versions No No description.
revapi:validate-configuration No No description.

System Requirements

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

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

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