SonarQubePrepare@6 — przygotowanie konfiguracji analizy w wersji 6

Artykuł
01/29/2025

Przygotuj konfigurację analizy SonarQube.

Nuta

Zadania SonarQube są częścią rozszerzenia SonarQube dla usługi Azure DevOps, które jest wstępnie zainstalowane w usługach Azure DevOps Services. Aby uzyskać więcej informacji i obsługę zadań SonarQube i SonarQube, zobacz rozszerzenie SonarQube dla usługi Azure DevOps, SonarQube — Visual Studio Marketplacei Sonar Community.

Składnia

# 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.

Wejścia

SonarQube - punkt końcowy serwera SonarQube
string. Wymagane.

Wybierz punkt końcowy serwera SonarQube dla projektu. Aby go utworzyć, kliknij link Zarządzaj i utwórz nowy punkt końcowy serwera SonarQube, wprowadź adres URL serwera i token.

scannerMode - Wybierz sposób uruchamiania analizy
string. Wymagane. Dozwolone wartości: MSBuild (integracja z programem MSBuild), Other (integracja z narzędziem Maven lub Gradle), CLI (użyj skanera autonomicznego). Wartość domyślna: MSBuild.

MSBuild

Umieść to zadanie przed zadaniem MSBuild
Dodaj zadanie "Run Code Analysis" po zadaniach MSBuild/VSTest

Maven/Gradle

Umieść to zadanie przed zadaniem Maven/Gradle
Zaznacz pole wyboru "Uruchom analizę SonarQube" w konfiguracji zadania Maven/Gradle.

Inni

W innych przypadkach można użyć autonomicznego skanera (sonar-skaner) i ustawić całą konfigurację z tym zadaniem, a następnie dodać zadanie "Run Code Analysis".

wersji programu MSBuild skanera
string. Fakultatywny. Użyj polecenia , gdy scannerMode = MSBuild.

Określ wersję skanera MSBuild do użycia. Wersje można znaleźć tutaj.

wersji interfejsu wiersza polecenia skanera
string. Fakultatywny. Użyj polecenia , gdy scannerMode = CLI.

Określ wersję skanera interfejsu wiersza polecenia do użycia. Wersje można znaleźć tutaj.

trybu
string. Wymagane, gdy scannerMode = CLI. Dozwolone wartości: file (Konfiguracja magazynu z moim kodem źródłowym (sonar-project.properties)), manual (Ręcznie podaj konfigurację). Wartość domyślna: file.

Wybierz preferowaną metodę konfiguracji.

pliku ustawień
string. Fakultatywny. Użyj polecenia , gdy scannerMode = CLI && configMode = file. Wartość domyślna: sonar-project.properties.

Więcej informacji jest dostępnych tutaj.

cliProjectKey - klucz projektu
string. Wymagane, gdy scannerMode = CLI && configMode = manual.

Unikatowy klucz projektu SonarQube, tj. sonar.projectKey.

projectKey - klucz projektu
string. Wymagane, gdy scannerMode = MSBuild.

Unikatowy klucz projektu SonarQube, tj. sonar.projectKey.

cliProjectName - nazwa projektu
string. Fakultatywny. Użyj polecenia , gdy scannerMode = CLI && configMode = manual.

Nazwa projektu SonarQube, tj. sonar.projectName.

projectName - nazwa projektu
string. Fakultatywny. Użyj polecenia , gdy scannerMode = MSBuild.

Nazwa projektu SonarQube, tj. sonar.projectName.

wersji projektu
string. Fakultatywny. Użyj polecenia , gdy scannerMode = CLI && configMode = manual. Wartość domyślna: 1.0.

Wersja projektu SonarQube, tj. sonar.projectVersion.

wersji projektu
string. Fakultatywny. Użyj polecenia , gdy scannerMode = MSBuild. Wartość domyślna: 1.0.

Wersja projektu SonarQube, tj. sonar.projectVersion.

katalog główny katalogu cliSources - Sources
string. Wymagane, gdy scannerMode = CLI && configMode = manual. Wartość domyślna: ..

Ścieżka do katalogu głównego zawierającego pliki źródłowe. Ta wartość jest ustawiona na właściwość sonar.sources SonarQube.

extraProperties - dodatkowe właściwości
string. Wartość domyślna: # Additional properties that will be passed to the scanner, \n# Put one key=value per line, example:\n# sonar.exclusions=**/*.bin.

dodatkowe właściwości, które mają zostać przekazane do skanera. Określ każdą parę key=value w nowym wierszu.

Opcje sterowania zadaniami

Wszystkie zadania mają opcje sterowania oprócz danych wejściowych zadań podrzędnych. Aby uzyskać więcej informacji, zobacz opcje kontroli i typowe właściwości zadań.

Zmienne wyjściowe

Żaden.

Uwagi