SonarQubePrepare@6 – Vorbereiten der Analysekonfiguration v6-Aufgabe

Artikel
11/07/2024

Vorbereiten der SonarQube-Analysekonfiguration.

Anmerkung

Die SonarQube-Aufgaben sind Teil der SonarQube-Erweiterung für Azure DevOps, die in Azure DevOps Services vorinstalliert ist. Weitere Informationen und Unterstützung für SonarQube- und SonarQube-Aufgaben finden Sie unter SonarQube-Erweiterung für Azure DevOps, SonarQube - Visual Studio Marketplaceund Sonar Community-.

Syntax

# Prepare Analysis Configuration v6
# Prepare SonarQube analysis configuration.
- task: SonarQubePrepare@6
  inputs:
    SonarQube: # string. Required. SonarQube Server Endpoint. 
    scannerMode: 'MSBuild' # 'MSBuild' | 'Other' | 'CLI'. Required. Choose the way to run the analysis. Default: MSBuild.
    #msBuildVersion: # string. Optional. Use when scannerMode = MSBuild. Scanner MSBuild Version. 
    #cliVersion: # string. Optional. Use when scannerMode = CLI. Scanner CLI Version. 
    #configMode: 'file' # 'file' | 'manual'. Required when scannerMode = CLI. Mode. Default: file.
    #configFile: 'sonar-project.properties' # string. Optional. Use when scannerMode = CLI && configMode = file. Settings File. Default: sonar-project.properties.
    #cliProjectKey: # string. Required when scannerMode = CLI && configMode = manual. Project Key. 
    projectKey: # string. Required when scannerMode = MSBuild. Project Key. 
    #cliProjectName: # string. Optional. Use when scannerMode = CLI && configMode = manual. Project Name. 
    #projectName: # string. Optional. Use when scannerMode = MSBuild. Project Name. 
    #cliProjectVersion: '1.0' # string. Optional. Use when scannerMode = CLI && configMode = manual. Project Version. Default: 1.0.
    #projectVersion: '1.0' # string. Optional. Use when scannerMode = MSBuild. Project Version. Default: 1.0.
    #cliSources: '.' # string. Required when scannerMode = CLI && configMode = manual. Sources directory root. Default: ..
  # Advanced
    #extraProperties: # string. Additional Properties.

Eingänge

SonarQube - SonarQube Server Endpoint
string. Erforderlich.

Wählen Sie den SonarQube-Serverendpunkt für Ihr Projekt aus. Um einen zu erstellen, klicken Sie auf den Link "Verwalten", und erstellen Sie einen neuen SonarQube Server-Endpunkt, geben Sie Ihre Server-URL und das Token ein.

scannerMode - Wählen Sie die Möglichkeit zum Ausführen der Analyse
string. Erforderlich. Zulässige Werte: MSBuild (Integration in MSBuild), Other (Integration in Maven oder Gradle), CLI (Eigenständiger Scanner verwenden). Standardwert: MSBuild.

MSBuild

Diese Aufgabe vor der MSBuild-Aufgabe ablegen
Hinzufügen der Aufgabe "Codeanalyse ausführen" nach den MSBuild/VSTest-Aufgaben

Maven/Gradle

Diesen Vorgang vor dem Maven/Gradle-Vorgang ablegen
Aktivieren Sie das Kontrollkästchen "SonarQube-Analyse ausführen" in der Maven/Gradle-Aufgabenkonfiguration.

Andere

In anderen Fällen können Sie den eigenständigen Scanner (Sonarscanner) verwenden und alle Konfigurationen mit dieser Aufgabe festlegen und dann die Aufgabe "Codeanalyse ausführen" hinzufügen.

msBuildVersion - Scanner MSBuild Version
string. Wahlfrei. Wird verwendet, wenn scannerMode = MSBuild.

Geben Sie die zu verwendende Version des MSBuild-Scanners an. Versionen können hiergefunden werden.

cliVersion - CLI-Version
string. Wahlfrei. Wird verwendet, wenn scannerMode = CLI.

Geben Sie die zu verwendende Version des CLI-Scanners an. Versionen können hiergefunden werden.

configMode - Modus-
string. Erforderlich, wenn scannerMode = CLI. Zulässige Werte: file (Store-Konfiguration mit meinem Quellcode (sonar-project.properties)), manual (Manuelle Konfiguration bereitstellen). Standardwert: file.

Wählen Sie Ihre bevorzugte Konfigurationsmethode aus.

configFile - Einstellungsdatei
string. Wahlfrei. Wird verwendet, wenn scannerMode = CLI && configMode = file. Standardwert: sonar-project.properties.

Weitere Informationen finden Sie hier.

cliProjectKey - Project Key-
string. Erforderlich, wenn scannerMode = CLI && configMode = manual.

Der einzigartige Schlüssel des SonarQube-Projekts, d. h. sonar.projectKey.

projectKey - Project Key-
string. Erforderlich, wenn scannerMode = MSBuild.

Der einzigartige Schlüssel des SonarQube-Projekts, d. h. sonar.projectKey.

cliProjectName - Projektname
string. Wahlfrei. Wird verwendet, wenn scannerMode = CLI && configMode = manual.

Der Name des SonarQube-Projekts, d. h. sonar.projectName.

projectName - Projektname
string. Wahlfrei. Wird verwendet, wenn scannerMode = MSBuild.

Der Name des SonarQube-Projekts, d. h. sonar.projectName.

cliProjectVersion - der Project-Version
string. Wahlfrei. Wird verwendet, wenn scannerMode = CLI && configMode = manual. Standardwert: 1.0.

Die Projektversion von SonarQube, d. h. sonar.projectVersion.

projectVersion - der Project-Version
string. Wahlfrei. Wird verwendet, wenn scannerMode = MSBuild. Standardwert: 1.0.

Die Projektversion von SonarQube, d. h. sonar.projectVersion.

cliSources - Verzeichnisstamm-
string. Erforderlich, wenn scannerMode = CLI && configMode = manual. Standardwert: ..

Pfad zum Stammverzeichnis, das Quelldateien enthält. Dieser Wert wird auf die sonar.sources SonarQube-Eigenschaft festgelegt.

extraProperties - zusätzliche Eigenschaften
string. Standardwert: # Additional properties that will be passed to the scanner, \n# Put one key=value per line, example:\n# sonar.exclusions=**/*.bin.

Zusätzliche Eigenschaften an den Scanner übergeben werden. Geben Sie jedes Schlüssel-Wert-Paar in einer neuen Zeile an.

Aufgabensteuerungsoptionen

Alle Aufgaben verfügen zusätzlich zu ihren Aufgabeneingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerelementoptionen und allgemeinen Aufgabeneigenschaften.

Ausgabevariablen

Nichts.

Bemerkungen