Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 36 Next »

Description / Features

Clirr checks Java libraries for binary and source compatibility with older releases. In a continuous integration process Clirr can automatically prevent accidental introduction of binary or source compatibility problems.

It measures the number of API break issues between the current sources and the last known stable version of the library in the Maven repository.


  1. Install the plugin through the Update Center or download it into the SONARQUBE_HOME/extensions/plugins directory
  2. Restart the SonarQube server


  1. Add at least one Clirr rule to your quality profile (Settings > Quality Profiles > select your profile > filter rules on repository 'Clirr') :
    • API Change adds new feature without breaking anything
    • API Change breaks the backward binary compatibility
    • API Change might change runtime expected behavior
  2. Define your project as an API project: browse to the project settings and set the property Clirr > API to true.
  3. Analyze your Maven project
  4. Browse to the dashboard and look at "API Changes" widget and page.

Known Limitations

  1. Only Java Maven projects are supported.
  2. As Clirr does not report line numbers, issues cannot be displayed in the correct location within the source code
  3. Issues of deleted components are assigned to the project

Change Log


Version 1.1 (1 issues)



Version 1.0 (1 issues)



Version 0.2 (2 issues)

  • No labels