paul/gilde-ci-cd
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge branch 'feat/update_sonar_docs' into 'master'

Browse Source 
docs(Sonar): Describe Sonar_token

See merge request gilden/ci/gitlab-ci-templates!54
This commit is contained in:
Karina Schaeffler 2022-03-04 11:58:32 +00:00
commit 6f42a0c2e4
1 changed files with 11 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
documentation/chapters/templates/tool-sonar7.adoc
View File

@ -3,32 +3,27 @@
= sonar-template = sonar-template
Ruft den Sonar Job für das Projekt auf. Ruft den Sonar Job für das Projekt auf.
Mehr Details zu finden hier: https://gitlab.exxcellent.de/gilden/ci/exxcellent-sonar-tool[Gilde CI/CD: exxcellent-sonar-tool].
Zum Einrichten von Sonar, lies bitte die Dokumentation die wir in https://www.exxcellent.de/confluence/x/RIWCC[Confluence] bereitstellen.
NOTE: Das jacoco Plugin ist verantwortlich für code coverage metriken.
Du musst das Plugin in deinen Abhängigkeiten installiert haben.
.Variables .Variables
|=== |===
|Name |Description | Default Value |Name |Description | Default Value
|SONAR_HOST_URL | Url des Sonar Host Systems | "http://sonar7.exxcellent.de/sonar7" |SONAR_HOST_URL | Die URL des eXXcellent sonar servers | http://sonar7.exxcellent.de/sonar7
|SONAR_TOKEN | Token um geschützte Sonar Funktionen auszuführen | ""
|SONAR_PROJECT_KEY | Der Sonar-Projekt-Key. | "" |SONAR_PROJECT_KEY | Der Sonar-Projekt-Key. | ""
|SONAR_PROJECT_NAME | Der Sonar-Projekt-Name. | "" |SONAR_PROJECT_NAME | Der Sonar-Projekt-Name. | "" (Es wird dann standardmäßig der Maven project.name verwendet)
|SONAR_EXCLUSIONS | Von Sonar auszuschließende Bereiche | **/target/**,**/src/test/**
(Es wird dann standardmäßig der Maven project.name verwendet)
|SONAR_EXCLUSIONS | Files die Sonar ausgeschlossen werden |"**/target/**,**/src/test/**"
|SONAR_SKIP_BUILD_BREAKER | Definiert ob der Build Breaker übersprungen werden soll | "true"
|SONAR_QUERY_MAX_ATTEMPTS_BUILD_BREAKER | Maximale Anzahl an Anfragen, um den Sonar-Report zu erhalten | "30"
|SONAR_QUERY_INTERVAL_BUILD_BREAKER | Zeit in Millisekunden zwischen 2 Anfragen, um den Sonar-Report zu erhalten | "10000"
|GRADLE_CLI_OPTS | Zusätzliche CLI Opts für Gradle | "" |GRADLE_CLI_OPTS | Zusätzliche CLI Opts für Gradle | ""
|=== |===
TIP: Der SONAR_TOKEN String kann über den persönlichen User Bereich in Sonar unter dem Tab _Security_ erzeugt werden.
Ein technischer User ist aktuell nicht möglich.
Das Token wird ausschließlich dafür benötigt, wenn der Sonar Buildbreaker über die Pipeline aktiviert wird (_sonar.buildbreaker.skip=true_).
Wenn der Build nicht gebrochen werden soll, kann es weggelassen werden.
.sonar-template .sonar-template
[source,yaml] [source,yaml]
---- ----
include::{sourcedir}/tool-sonar7.gitlab-ci.yml[] include::{sourcedir}/tool-sonar7.gitlab-ci.yml[]
---- ----