Come iniziare
bitegarden Generic Issue Data Exporter for SonarQube™ richiede la versione di Java 8.
Una volta scaricato il prodotto, avrai un file "jar" auto-eseguibile.
Semplicemente, posizionalo nel tuo file system ed esegui il jar con l'opzione "--help" per vedere tutte le opzioni disponibili:
java -jar bitegarden-generic-issue-data-exporter-for-sonarqube.jar --help
Come risultato, otterrai qualcosa del genere:
...
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)
...
Tutti le proprietà si possono ottenre attraverso la linea di comando come argomenti utilizzando "-D" o
attraverso un file di configurazione personalizzato.
Se utilizzi una configurazione personalizzata dovrai eseguire l'applicazione con l'argomento -Dconfig.file"
proporzionando l'indirizzo del file di configurazione nelle proprietà della configurazione:
java -Dconfig.file=config.properties -jar bitegarden-generic-issue-data-exporter-for-sonarqube.jar --help
Se lo preferisci puoi fornire tutti i parametri attraverso la linea di comando "-D":
java -Dsonar.project.key=MYPROJECTKEY -Dsonar.host.url=MYSONARURL -Dsonar.repository.keys=MYRULESREPOSITORY ... -jar bitegarden-generic-issue-data-exporter-for-sonarqube.jar
Se un'opzione è definita in entrambe le posizioni (un file di configurazione e un argomento della riga di
comando) verrà utilizzato il valore fornito nella riga di comando.
In questo modo potrai avere un file di configurazione comune con proprietà condivise (come sonar.token,
sonar.host.url, ...) e quindi utilizzare semplicemente gli argomenti per le opzioni concrete come "sonar.project.key", per esempio.
Generazione di data utilizzando la license key
Per impostazione predefinita, quando scarichi il prodotto potrai utilizzarlo per 14 giorni.
Una volta terminata la valutazione, tu sarà necessario acquistare il prodotto per ottenere una chiave di licenza valida.
La license key verrà fornita come file di testo. Per utilizzare questo file di licenza devi impostare la proprietà "license.file"
nel tuo file di configurazione (o tramite args da riga di comando) con il percorso del file della licenza.
La licenza è collegata all'ID del server dell'istanza SonarQube™ da cui si desidera esportare i problemi.
Questo è un esempio di esecuzione di un prodotto concesso in licenza utilizzando un argomento della riga di comando:
java -Dconfig.file=config.properties -Dlicense.file=PATH_TO_LICENSE_FILE -jar bitegarden-generic-issue-data-exporter-for-sonarqube.jar --help
Sta a te includere la proprietà "license.file" nel tuo file di configurazione o usarla come argomento della riga di comando con "-D".
Supporto e assitenza
Quando generi i report, il plugin mostrerà tutte le informazioni con la tua configurazione e con le informazioni sulla licenza attraverso lo standard output.
In caso di problemi, crea una richiesta di supporto nel nostro customer portal e saremo lieti di aiutarti a trovare una soluzione.
Richiedi Supporto
