Goals Overview

The plugin offers the following goals:

• clirr:check is used as part of the build to ensure a configurable level of compatibility.
• clirr:clirr generates a report for the project's website.
• clirr:check-arbitrary Check for compatibility between two arbitrary artifact sets.
• clirr:check-no-fork Check for compatibility with previous version without forking the project

Usage

General instructions on how to use the Clirr Maven Plugin can be found on the usage page.

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

To provide you with better understanding of some usages of the Clirr Maven Plugin, you can take a look into the following examples:

• Comparing the current version against a specific version.
• Comparing the current version against an arbitrary different artifact.
• Ignoring differences that would otherwise be reported.