Clirr Plugin for SonarQube
Switch branches/tags
Nothing to show
Clone or download
simonbrandhof Use Java 8 on Travis
Executing integration tests with SonarQube 5.6 require
to upgrade to Java 8
Latest commit d71b447 Jun 9, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
its Upgrade to orchestrator 3.10.1 Feb 3, 2016
src Fix some quality flaws Nov 10, 2015
.gitignore Add .gitignore Dec 3, 2013
.sonarsource.properties Trigger SQ analysis from Travis Nov 28, 2015
.travis.yml Use Java 8 on Travis Jun 9, 2016
README.md Add build status May 26, 2016
pom.xml Restore url May 26, 2016
quick-build.sh chmod +x quick-build.sh Nov 28, 2015
travis.sh Use Java 8 on Travis Jun 9, 2016

README.md

SonarQube Clirr Plugin

Build Status

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>