Versions Compared

Key

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

...

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.

Installation

...

Use Update Center or download plugin into the directory $SONAR_HOME/extensions/plugins

...

/

...

Configuration

  1. Add at least one Clirr rule to your quality profile (Configuration -> Quality Profiles -> select your profile -> filter rules on plugin '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 (execute mvn sonar:sonar)
  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, violations cannot be displayed in the correct location within the source code
  3. Violations of deleted resources/classes are assigned to the project

...