Guía Rápida
bitegarden Generic Issue Data Exporter for SonarQube™ requiere Java 8 o superior.
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-generic-issue-data-exporter-for-sonarqube.jar --help
Como resultado obtendrás algo parecido a esto:
...
bitegarden Generic Issue Data Exporter for SonarQube. Command Line usage:
java -Dconfig.file=PATH_TO_CONFIG_FILE -Dlicense.file=PATH_TO_LICENSE_FILE ... -jar bitegarden-sonarqube-generic-issue-data-exporter.jar
config.file = path to properties file including all the parameters required to export the data.
This is optional. You can set all the properties through command line args using -DpropertyName=propertyValue
Note that if you use a config file and command line arguments, arguments will override config file
license.file = path to file with your license key provided by bitegarden.
By default a 14 days trial version will be used if license file is not provided
Mandatory properties:
sonar.project.key = the project key to export issues from
sonar.host.url = your SonarQube host URL.
sonar.token = your user security token to authenticate against SonarQube.
It is recommended to generate a new token for this app.
sonar.repository.keys = Rules repository keys list separated by comma to search issues.
sonar.rule.keys = Rules keys list separated by comma to search issues.
(this parameter is required if repository keys parameter is not provided)
Optional properties:
output = File name for the generated report (without .json extension)
...
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=config.properties -jar bitegarden-generic-issue-data-exporter-for-sonarqube.jar --help
Si lo prefieres puedes pasar todas las opciones a través de la línea de comandos con "-D":
java -Dsonar.project.key=MYPROJECTKEY -Dsonar.host.url=MYSONARURL -Dsonar.repository.keys=MYRULESREPOSITORY ... -jar bitegarden-generic-issue-data-exporter-for-sonarqube.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 o sonar.host.url) y después simplemente usar los argumentos para las opciones concretas como es
“sonar.project.key”, por ejemplo.
Exportando issues con una clave de licencia
Por defecto cuando descargas el producto lo 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 al Server ID de la instancia de SonarQube™ del que quieras exportar las issues.
Aquí tienes un ejemplo para exportar issues usando una licencia del producto a través de un argumento por línea de comandos:
java -Dconfig.file=config.properties -Dlicense.file=PATH_TO_LICENSE_FILE -jar bitegarden-generic-issue-data-exporter-for-sonarqube.jar --help
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
Cuando utilices el producto se 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
