Overview for SonarQube™ Cloud

This command-line tool for SonarQube™ Cloud enables you to generate a report of project groupings: bringing together the entire organisation or using project tags for the different groupings.

TRY IT FREE BUY NOW

If your organisation uses the SonarQube™ Server version, we have the equivalent solution: Overview Report for SonarQube™ Server, offering the same benefits and easy to use. bitegarden Overview Report for SonarQube™.

Discover the Overview Report Plugin for SonarQube™ >

Generating a report has never been so simple: you only need the command line, and you can integrate the process into your CI/CD pipeline so that your reports are updated automatically.

Each report shows:

- Total bugs, vulnerabilities and code smells.
- Project size and percentage of duplicated code.
- Test coverage and metric distribution per project.
- Summary of the most detected rules and evidence, organised by severity.

PDF generation includes several options to customise the report:

- Report language: Spanish or English.
- Include your company logo in the footer.
- Adapt it to any language or technology supported by SonarQube Cloud.

With this information, your team will always have a clear overview, without wasting time interpreting scattered metrics, and will be able to prioritise issues effectively.

bitegarden Overview Report for SonarQube™ Cloud requires at least Java 8 to run.

Quick Guide: generate PDF overview reports from SonarQube™ Cloud

Here you have a quick usage guide to generate PDF reports for your organization in SonarQube™ Cloud.

Once you have downloaded the product you will have an auto executable "jar" file.

Just put it anywhere in your filesystem and run the jar with --help option to see all the available options:

java -jar bitegarden-sonarcloud-overview-report.jar --help

You will get something like this:

...
Mandatory properties:

                 sonar.token = your user token to authenticate against SonarCloud.
                               It is recommended to generate a token for this app.

       sonar.organizationKey = the SonarCloud organization to generate the report from.


Optional properties:

           sonar.projectTags = Comma separated list of project tags to use for the report (i.e: team1,team2)

     sonar.projectExclusions = Comma separated list of project to exclude from the report (i.e: pkey1,pkey2)

 hotspotsBySeverity.disabled = Default is false. If you don't need hotspots by severity section you may want to disable this.
                               Setting it to true will improve performance but hotspot by severity section will not be available.

             activity.period = Defines the dates to generate activity section and project breakdown differential values
                               0 (since first analysis) Default value
                               1 (since six months ago)
                               2 (since last month)
                               YYYY-MM-DD (since specified date)

             stagnant.months = number of months since last analysis to consider a project is stagnant

                  footer.url = URL of the image to display centered in footer (PNG or JPG format are supported)
                               If image height is bigger than 25px it will be resized.

                 user.locale = Locale to use for generated PDF file. Options are English (user.locale=en) or Spanish (user.locale=es)

                      output = File name for the generated report

...

All the properties should be passed to the command line app using Java system properties with "-D" or using a custom properties file.

If you use a custom properties file you should run the application with the "config.file" parameter and provide the path to the properties file:

java -Dconfig.file=myoverviewconfig.properties -jar bitegarden-sonarcloud-overview-report.jar

If you just want to pass the required parameters through system properties use "-D" arguments when running the report:

java -Dsonar.token=mytoken -Dsonar.organizationKey=myorg  -jar bitegarden-sonarcloud-overview-report.jar

If a property is defined in both locations (file and command line args) the command line property will override the property in the file. This way you can have a generic configuration file with the common properties (sonar.token, sonar.organizationKey, ...) and then use command line args for specific properties like sonar.projectTags.

java -Dconfig.file=myoverviewreport.properties -Dlicense.file=PATH_TO_LICENSE_FILE -jar bitegarden-sonarcloud-overview-report.jar