Getting Started
bitegarden Overview Report for SonarCloud™ requires at least Java 8 to run.
Quick Guide: generate PDF overview reports from SonarCloud™
Here you have a quick usage guide to generate PDF reports for your organization in 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-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.
Running the report with a license key
By default when you download the product you will be able to use it during 14 days. Once your evaluation is finished, you
will need to purchase the product and get a valid license key.
The license key will be provided as a text file. In order to use this license file you must set the property "license.file" in your
configuration file (or through command line args) with the path of your license file.
The license key is bound to your organization key.
This is a sample running a licensed product using a command line argument:
java -Dconfig.file=myoverviewreport.properties -Dlicense.file=PATH_TO_LICENSE_FILE -jar bitegarden-sonarcloud-overview-report.jar
It is up to you to include the "license.file" property in your configuration file or use it as a command line argument with "-D".
Troubleshooting and Support
If your SonarCloud™ organization has hundreds of projects the report generation may be slow. We must gathered
all the information from SonarCloud™ to generate the PDF file. Thank you for your patient!
When you run the report all the information for both the license and the configuration will be displayed
on the standard output.
If you have any problem please open a support request in our customer portal and we will
be happy to help you find a solution.
Request Support
