Report Generation for SonarCloud™

bitegarden Report for SonarCloud™ is what you need.

TYPES OF REPORTS

This plugin (command line application) is bundled with PDF predefined reports that provide clear information about code quality and security of your project.

One beautiful executive summary report with all the metrics in a single page or a full report with all the findings (bugs, vulnerabilities, security hotspots and code smells).

THE QUALITY OF YOUR PROJECT ALWAYS UNDER CONTROL

bitegarden Report for SonarCloud™ saves much of the time it takes to generate status reports on the quality and security of your projects. You will be able to download a PDF or excel report of your project in a few seconds, when you want, with all the information of the project at that moment.

TRY IT FREE BUY NOW

Are you looking for report generation for SonarQube™ on-premise edition? Check out bitegarden Report for SonarQube™.

Discover the Report Plugin for SonarQube >

Main features include:

- Java Command Line Tool that can be used standalone or integrated into your CI/CD tool as a step to automatically generate the report.
- SonarCloud™ executive summary report in PDF with all the code quality metrics in just one single page
- SonarCloud™ issues breakdown summary report in PDF with the executive summary and a summary of all the issues found
- SonarCloud™ issues breakdown full report in PDF with all the issues found
- SonarCloud™ executive summary and issues breakdown report in excel with all the issues found

PDF generation includes additional customizations:

- Support for branches: generate PDF or excel reports for any of your project branches.
- Support for all SonarCloud™ languages and technologies.
- Support for custom footer logo to add your organization logo. (Only PDF)

bitegarden Report for SonarCloud™ requires Java 8 to run.

QUICK GUIDE: GENERATE PDFS OF PROJECTS IN SONARCLOUD ™

Here you have a quick usage guide to generate PDF reports from SonarCloud™.

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-report.jar --help

You will get something like this:

...
Mandatory properties:

           sonar.token = your user token to authenticate against SonarCloud
      sonar.projectKey = the project key from SonarCloud. You can find it in SonarQube project information
 sonar.organizationKey = the SonarCloud organization the project belongs to
           report.type = 0 (executive summary) Default value
                         1 (issues summary)
                         2 (full issues breakdown)
                         3 (excel report)
                         4 (Vulnerabilities, Bugs and Code Smells summary report)
                         5 (Security Hotspots summary report)
                         6 (Vulnerabilities, Bugs and Code Smells breakdown report)
                         7 (Security Hotspots breakdown report)

Optional properties:

         sonar.branch = the branch where we will get the information for the report (default is main branch)
    sonar.pullRequest = the pull request where we will get information for the report
* disable.qualitygate = If you enable this option the quality gate status won't be displayed (default is false)
   * disable.coverage = If you enable this option the coverage section in the summary page won't be displayed (default is false)
         * footer.url = URL of the image to display centered in footer (PNG or JPG format are supported)
          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

* Properties only supported on PDF 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=myreportconfig.properties -jar bitegarden-sonarcloud-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.projectKey=myprojectkey -Dsonar.organizationKey=myorg -Dreport.type=0 -jar bitegarden-sonarcloud-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, report.type, ...) and then use command line args for specific properties like sonar.projectKey or sonar.branch.

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