Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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.

Installation

  1. Install the Clirr plugin through the Update Center or download it into the SONARSONARQUBE_HOME/extensions/plugins directory
  2. Restart the Sonar SonarQubeTM server

Configuration

  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.

...