SonarQube Clirr Plugin

Checks Java libraries for binary and source compatibility with older releases

License	GNU LGPL 3
Categories	CLI User Interface
GroupId	org.codehaus.sonar-plugins
ArtifactId	sonar-clirr-plugin
Last Version	1.2
Release Date	Jan 14, 2015
Type	sonar-plugin
Description	SonarQube Clirr Plugin Checks Java libraries for binary and source compatibility with older releases
Project URL	http://redirect.sonarsource.com/plugins/clirr.html
Project Organization	SonarSource
Source Code Management	https://github.com/SonarCommunity/sonar-clirr

Download sonar-clirr-plugin

Filename	Size
sonar-clirr-plugin-1.2.pom
sonar-clirr-plugin-1.2.jar	17 KB
sonar-clirr-plugin-1.2-sources.jar	13 KB
sonar-clirr-plugin-1.2-javadoc.jar	71 KB

Dependencies

compile (1)

Group / Artifact	Type	Version
commons-io : commons-io	jar	2.4

provided (2)

Group / Artifact	Type	Version
org.codehaus.sonar : sonar-plugin-api	jar	4.5.1
org.codehaus.sonar-plugins.java : sonar-java-plugin	sonar-plugin	2.4

test (3)

Group / Artifact	Type	Version
org.codehaus.sonar : sonar-testing-harness	jar	4.5.1
org.easytesting : fest-assert	jar	1.4
org.apache.maven : maven-project	jar	2.2.0

Project Modules

There are no modules declared in this project.

SonarQube Clirr Plugin

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 can measure the number of API break issues between the current sources and another version of the library. The reference version can be automatically downloaded from the Maven repository when using the Clirr Maven plugin.

Configuration

1. Add at least one Clirr rule to your quality profile (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

1. Configure path of Clirr text report using property sonar.clirr.reportPath
2. Analyze your project
3. Check for new issues from Clirr rule repository.

Produce Clirr text report using Maven

<build>
  <plugins>
    <plugin>
      <groupId>org.codehaus.mojo</groupId>
      <artifactId>clirr-maven-plugin</artifactId>
      <configuration>
        <comparisonVersion>X.Y</comparisonVersion>
        <textOutputFile>${project.build.directory}/clirr-report.txt</textOutputFile>
        <linkXRef>false</linkXRef>
        <failOnError>false</failOnError>
      </configuration>
      <executions>
        <execution>
          <id>clirr</id>
          <goals>
            <goal>check-no-fork</goal>
          </goals>
        </execution>
      </executions>
    </plugin>
  </plugins>
</build>

Versions

Version
1.2 Jan 14, 2015
1.1 May 23, 2011
1.0 Nov 14, 2010
0.2 Apr 27, 2010