SonarQubePrepare@4. Задача "Подготовка конфигурации анализа" версии 4

Статья
05/14/2024

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

Синтаксис

# Prepare Analysis Configuration v4
# Prepare SonarQube analysis configuration.
- task: SonarQubePrepare@4
  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-scanner), задать все конфигурации с этой задачей Run Code Analysis , а затем добавить задачу.

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

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

configFile - Файл параметров
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.

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

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

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

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

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

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

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

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

cliSources - Корень каталога источников
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 пару в новой строке.

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

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

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

Нет.

Remarks

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

Требования

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

См. также раздел

Интеграция SonarQube Azure DevOps

Share via