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 4 Next »

Compatibility with Sonar

Plugin versions












Description / Features

Clirr is a tool that 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.

This Sonar plugin measures the number of API break violations between the current sources and the last known stable version of the library in the Maven repository.

Usage & Installation

  1. Stop Sonar Web server
  2. Place the jar into the /extensions/plugins directory
  3. Restart Sonar Web server
  4. Enable clirr plugin in Project > Settings > Clirr by setting [sonar.clirr.execute property to true
  5. Enable the following three violation rules in your Quality Profile (Configuration > Quality Profiles).
    • API Change adds new feature without breaking anything
    • API Change breaks the backward binary compatibility
    • API Change might change runtime expected behavior
  6. Run mvn sonar:sonar on your Maven project
  7. Go to Sonar Dashboard and look at "API Changes" section

Known limitations

  1. As Clirr does not report line numbers, violations cannot be displayed in the correct location within the source code
  2. Violations of deleted resources/classes are assigned to the project
  • No labels