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

Статья
11/07/2024

Подготовка конфигурации анализа SonarQube.

Заметка

Задачи SonarQube входят в расширение SonarQube для Azure DevOps, которое предварительно установлено в Azure DevOps Services. Дополнительные сведения и поддержку задач SonarQube и SonarQube см. в расширении SonarQube для Azure DevOps, SonarQube — Visual Studio Marketplaceи Sonar Community.

Синтаксис

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

Входы

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

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

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

MSBuild

Поместите эту задачу перед задачей MSBuild
Добавьте задачу "Анализ кода" после задач MSBuild/VSTest

Maven/Gradle

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

Другие

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

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

Укажите версию используемого сканера MSBuild. Версии можно найти здесь.

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

Укажите версию средства проверки CLI для использования. Версии можно найти здесь.

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

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

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

Дополнительные сведения доступны здесь.

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 в новой строке.

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

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

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

Никакой.

Замечания