Report Plugin for SonarQube™

Generate your project report from a fully customizable ODT template

Installation and setup is quite easy


  1. Use bitegarden update center or copy jar file downloaded on SonarQube™ plugins folder:

    $SONAR_HOME/extensions/plugins/
  2. Restart SonarQube server.
  3. Log in with administrator rights, go to your SonarQube™ global settings, and then select the plugin in general settings.
  4. Paste license key and save.

It is required a new analysis in order to view the results if you want to use the custom ODT template.

Try it free Buy Now

Report Management


You can find all the related reports clicking in "More..." option and then in "Reporting" section inside your SonarQube™ project space menu.

You will access a new page with all the available reports:

- Executive PDF Summary Report: a clean and minimalistic report with all the information in just one page.
- Custom Open Document (ODT) Report: a custom report created using an Open Document template that you can modify.

report management section

Report Management page provided by bitegarden Report Plugin

Customize your report template


Create your custom template and setup the plugin to use your file through administration settings.

Download the default template to see how it works

Report Plugin for SonarQube™ allows you to configure the template file globally or at project level. Besides, the templates are provided through URLs, so it is not mandatory to have access to the machine where SonarQube™ is running.

Custom Report configuration


The report configuration is the template itself. This template is an OpenDocument text document and can be easily edited with OpenOffice or LibreOffice.

To generate the templates, a subset of the FreeMarker language template is used. Some valid expressions are:

  • ${ncloc} : Replaces the expression ncloc with its value. If ncloc is not available at execution time the report generation will stop.
  • ${ncloc!} : Replaces the expression ncloc with its value if exists.
  • ${ncloc!"No lines"} : Replaces the expression ncloc with its value if exists. Otherwise, it will show "No lines" (without the double quotes).
  • [#if ncloc > 10000] : If ncloc > 10000 we show everything till "else", otherwise, we show the next text block.
    Big project
    [#else]
    Small project
    [/#if]

You have to be careful with how OpenOffice generates the templates. It happens oftenly that expressions are not saved as a single element. To fix this, we need to click on "clear direct formatting" (select text and click right button).

Notice that, in order to work properly, all the expressions must be well formed and have to be evaluable.

Available variables for the template


The available variables are all the SonarQube metrics for the project, where the hyphens ('-') have been replaced with underlines ('_'), and others like project_name, project_description, analysis_date y analysis_version.

Get your SonarQube™ reports right now!



Download and Try

FREE TRIAL

  • 14 days evaluation license
  • After submitting the form your download will start and it will include your trial key
  • By using this form you will download LTS compatible version, go to downloads for other supported versions