Primeros pasos
bitegarden Overview Report for SonarCloud™ requiere Java 8 o superior.
Guía rápida: genera un informe PDF de tu organización de SonarCloud™
Una vez que hayas descargado el producto tendrás un fichero "jar" auto ejecutable.
Simplemente ubícalo en tu sistema de ficheros y ejecuta el jar con la opción "--help" para ver todas las opciones disponibles:
java -jar bitegarden-sonarcloud-overview-report.jar --help
El resultado debería mostrarte todas las opciones disponibles:
...
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
...
Todas las propiedades pueden proporcionarse a través de la línea de comandos como argumentos del sistema usando "-D" o a través de un fichero
de configuración personalizado.
Si utilizas un fichero de configuración personalizado deberás ejecutar la aplicación con el argumento "-Dconfig.file" proporcionando la ruta a tu fichero
de propiedades con la configuración:
java -Dconfig.file=myoverviewconfig.properties -jar bitegarden-sonarcloud-overview-report.jar
Si lo prefieres puedes pasar todas las opciones a través de la línea de comandos con "-D":
java -Dsonar.token=mytoken -Dsonar.organizationKey=myorg -jar bitegarden-sonarcloud-overview-report.jar
Si una opción está definida en ambos sitios (un fichero de configuración y un argumento por línea de comandos) se usará
el valor proporcionado en la línea de comandos. De esta forma puedes tener un fichero de configuración común con las propiedades
compartidas (como por ejemplo sonar.token, sonar.organizationKey, ...) y después simplemente usar los argumentos para
las opciones concretas como es "sonar.projectTags", por ejemplo.
Generando un informe usando clave de licencia
Por defecto cuando descargas el producto podrás utilizar durante 14 días en modo evaluación. Una vez que la
evaluación haya terminado, necesitarás adquirir el producto y obtener un clave de licencia válida.
La clave de licencia se proporciona en un fichero de texto. Para usar este fichero de licencia debes establecer
la propiedad "license.file" con la ruta hasta el fichero de licencia en tu fichero de configuración (o a través
de un argumento por línea de comandos).
La licencia está ligada a la clave de tu organización.
Aquí tienes un ejemplo para generar un informe usando una licencia del producto a través de un argumento por línea
de comandos:
java -Dconfig.file=myoverviewreport.properties -Dlicense.file=PATH_TO_LICENSE_FILE -jar bitegarden-sonarcloud-overview-report.jar
Está en tus manos decidir si quieres incluir la propiedad "license.file" en tu fichero de configuración o usarla a través de
un argumento por línea de comandos con "-D".
Soporte y resolución de problemas
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!
Cuando generes los informes el producto de mostrará toda la información con tu configuración y con la información
de la licencia por la salida estándar.
Si tienes algún problema por favor crea una petición de soporte en nuestro
centro de soporte y
estaremos encantados de ayudarte a encontrar una solución.
Solicita Soporte
