Revapi Maven Plugin

Revapi Maven plugin enables API checks during the Maven build. By default, it checks the currently built project against the its latest released version (as reported by Maven). Alternatively, the two artifacts to can be set arbitrarily.

The plugin offers the following Maven goals:

revapi:check is used as part of the build to ensure a configurable level of compatibility.
revapi:report generates a simple report for the project’s maven-generated site.
revapi:report-aggregate runs a report on all projects in a reactor using a configuration supplied at the top-level aggregator project.
revapi:validate-configuration validates the configuration of Revapi (use this to debug problems with the configuration).
revapi:update-versions updates the version string in pom.xml according to semver rules.
revapi:update-release-properties updates the release.properties file with the release and development versions as determined by Revapi according to the semver rules.

The full description of all available goals is located here.

Usage

Revapi maven plugin is very simple to use. Just define what revapi extensions should be used, what artifacts to compare and off you go. See the examples section, below.

In case you still have questions regarding the plugin’s usage, please feel free to contact the user mailing list. The posts to the mailing list are archived and could already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching the mail archive.

If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our issue tracker. When creating a new issue, please provide a comprehensive description of your concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason, entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated. Of course, patches are most welcome, too. Contributors can check out the project from our source repository and will find supplementary information in the guide to helping with Maven.

Examples

The list of extensions you want to use with Revapi is provided to it as plugin dependencies. Usually you will want to check the API of your java archives, so this is the minimal configuration you need to provide to revapi (note that the basic features extension is implicitly present because without it Revapi can do literally nothing).

<plugin>
  <groupId>org.revapi</groupId>
  <artifactId>revapi-maven-plugin</artifactId>
  <version>0.13.5</version>
  <dependencies>
    <dependency>
      <groupId>org.revapi</groupId>
      <artifactId>revapi-java</artifactId>
      <version>0.28.1</version>
    </dependency>
  </dependencies>
  <executions>
    <execution>
      <goals><goal>check</goal></goals>
    </execution>
  </executions>
</plugin>