Skip to content

Latest commit

 

History

History
67 lines (41 loc) · 3.93 KB

README.md

File metadata and controls

67 lines (41 loc) · 3.93 KB

SVG Badges plugin for SonarQube

Plugin for SonarQube that provides a webservice to retrieve projects' quality gate status as a SVG image similarily to travis-ci build status badges. You can see a running example below.

Travis build status Quality Gate

Badges types

Five different images types are generated depending on the plugin's execution:

  • Passing indicates that the project passes the quality gate (QG)
  • Warning indicates that the project does not pass the quality gate due to QG warnings
  • Failing indicates that the project does not pass the quality gate due to QG errors
  • No Gate indicates that no quality gate has been set for the specified project
  • Server error indicates that a server error occurred while generating the image
  • Not Found indicates that the project / view could not be found
  • Forbidden indicates that access to the project's / view's page requires authentication (see known limitations section below)

Usage

Installation

In order to use this plugin on your SonarQube server instance, you need first to install it. The plugin is available in SonarQube's update center under the name "SVN Badges".

Then you need to set SonarQube's sonar.core.serverBaseURL property to the URL of your SonarQube's server. This configuration step is mandatory. If this property is not set (i.e. default value is used) the plugin may behave incorrectly as SonarQube REST API may be unreachable.

Displaying your badge on a web page

Once the plugin is installed, you can display generated badge and link to your SonarQube project's or view's page using HTML or Markdown as follows.

Note that the plugin is currently installed on SonarQube's Nemo public instance. If you want to display a badge for one of the Opensource project analyzed on Nemo, just use nemo.sonarqube.org as <serverBaseURL>.

HTML Link:

<a href="<serverBaseURL>/dashboard/index/<key>"><img src="<serverBaseURL>/api/badges/gate?key=<key>"/></a>

Example:

<a href="http://localhost:9000/dashboard/index/com.qualinsight.plugins.sonarqube:qualinsight-plugins-sonarqube-badges"><img src="http://localhost:9000/api/badges/gate?key=com.qualinsight.plugins.sonarqube:qualinsight-plugins-sonarqube-badges"/></a>

Markdown Link:

[![Quality Gate](<serverBaseURL>/api/badges/gate?key=<key>)](<serverBaseURL>/dashboard/index/<key>)

Example:

[![Quality Gate](http://localhost:9000/api/badges/gate?key=com.qualinsight.plugins.sonarqube:qualinsight-plugins-sonarqube-badges)](http://localhost:9000/dashboard/index/com.qualinsight.plugins.sonarqube:qualinsight-plugins-sonarqube-badges)

REST documentation

The webservice is self-documented. Once installed, go to the webservice documentation page of your SonarQube instance and look at the documentation for /api/badges.

Known limitations

  • if authentication is required on your SonarQube instance in order to access a project's page, then the plugin is currently unable to retrieve data required to build SVN badges due to a SonarQube limitation (see issue #15.)

Conclusion

New feature ideas and contributions are more than welcome. A Google group named SVG Bagdes has been created in order to facilitate discussions about this plugin. This project's quality can be followed on Nemo.