SonarQubePrepare@5 — задача подготовки конфигурации анализа версии 5

Статья
02/24/2025

Используйте эту задачу для подготовки конфигурации анализа SonarQube.

Заметка

Эта задача устарела; используйте SonarQubePrepare@7.

Синтаксис

# Prepare Analysis Configuration v5
# Prepare SonarQube analysis configuration.
- task: SonarQubePrepare@5
  inputs:
    SonarQube: # string. Required. SonarQube Server Endpoint. 
    scannerMode: 'MSBuild' # 'MSBuild' | 'Other' | 'CLI'. Required. Choose the way to run the analysis. Default: MSBuild.
    #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.

Входы

SonarQube - конечная точка сервера SonarQube
string. Обязательно.

Указывает конечную точку сервера SonarQube для проекта. Чтобы создать его, щелкните ссылку Manage, создайте новую конечную точку сервера SonarQube и введите URL-адрес сервера и маркер.

scannerMode - Выберите способ выполнения анализа
string. Обязательно. Допустимые значения: MSBuild (интеграция с MSBuild), Other (интеграция с Maven или Gradle), CLI (использовать автономный сканер). Значение по умолчанию: MSBuild.

MSBuild

Поместите эту задачу перед задачей MSBuild.
Добавьте задачу Run Code Analysis после задач MSBuild/VSTest.

Maven/Gradle

Поместите эту задачу перед задачей Maven/Gradle.
Установите флажок Run SonarQube Analysis в конфигурации задачи Maven/Gradle.

другие

В других случаях можно использовать автономный сканер (sonar-сканер), задать все конфигурации с этой задачей, а затем добавить задачу Run Code Analysis.

режима
string. Требуется, если scannerMode = CLI. Допустимые значения: file (конфигурация Магазина с исходным кодом (sonar-project.properties)), manual (вручную укажите конфигурацию). Значение по умолчанию: file.

Указывает предпочитаемый метод конфигурации.

параметров
string. Необязательный. Используется при scannerMode = CLI && configMode = file. Значение по умолчанию: sonar-project.properties.

Задает параметры конфигурации и свойства проекта. Дополнительные сведения о расширении SonarQube для Azure DevOps.

cliProjectKey - ключ проекта
string. Требуется, если scannerMode = CLI && configMode = manual.

Указывает уникальный ключ проекта SonarQube. Например, sonar.projectKey.

projectKey - ключ проекта
string. Требуется, если scannerMode = MSBuild.

Указывает уникальный ключ проекта SonarQube. Например, sonar.projectKey.

имени проекта
string. Необязательный. Используется при scannerMode = CLI && configMode = manual.

Указывает имя проекта SonarQube. Например, sonar.projectName.

имени проекта
string. Необязательный. Используется при scannerMode = MSBuild.

Указывает имя проекта SonarQube. Например, sonar.projectName.

версии проекта
string. Необязательный. Используется при scannerMode = CLI && configMode = manual. Значение по умолчанию: 1.0.

Указывает версию проекта SonarQube. Например, sonar.projectVersion.

версии проекта
string. Необязательный. Используется при scannerMode = MSBuild. Значение по умолчанию: 1.0.

Указывает версию проекта SonarQube. Например, sonar.projectVersion.

корневой каталога источников
string. Требуется, если scannerMode = CLI && configMode = manual. Значение по умолчанию: ..

Указывает путь к корневому каталогу, содержаму исходные файлы. Это значение имеет значение sonar.sources свойству SonarQube.

extraProperties - дополнительные свойства
string. Значение по умолчанию: # Additional properties that will be passed to the scanner, \n# Put one key=value per line, example:\n# sonar.exclusions=**/*.bin.

Указывает дополнительные свойства, которые передаваться сканеру. Укажите каждую пару key=value в новой строке.

Параметры управления задачами

Все задачи имеют параметры управления в дополнение к входным данным задачи. Дополнительные сведения см. в разделе Параметры управления и общие свойства задач.

Выходные переменные

Никакой.

Замечания

Заметка

Эта задача устарела; используйте SonarQubePrepare@7.

поддержка проектов, отличных от MSBuild: Эта задача также может настроить анализ для проектов, отличных от MSBuild.

Требования

Требование	Описание
Типы конвейеров	YAML, классическая сборка
Выполняется в	Агент, DeploymentGroup
требования	Никакой
возможностей	Эта задача не удовлетворяет требованиям к последующим задачам в задании.
ограничения команд	Любой
переменные settable	Любой
Версия агента	2.144.0 или более поздней версии
Категория задач	Строить

См. также

SonarQube Azure DevOps Integration

Поделиться через