Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

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 plugin through the Update Center or download it into the SONARQUBE_HOME/extensions/plugins directory
  2. Restart the SonarQube server

Include Page
Include - Plugin Installation
Include - Plugin Installation

Configuration

  1. Add at least one Clirr rule to your quality profile (Settings > Quality Profiles > select 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 the "API Changes" widget and page.

...

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

Change Log

...