Share via

SonarQubePrepare@4 – Preparar a tarefa de Configuração de Análise v4

  • Artigo

Use essa tarefa para preparar uma configuração de análise do SonarQube.

Syntax

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

Entradas

SonarQube - Ponto de extremidade do servidor SonarQube
string. Obrigatórios.

Especifica o ponto de extremidade do servidor SonarQube para seu projeto. Para criar um, clique no Manage link, crie um novo ponto de extremidade do servidor SonarQube e insira a URL e o token do servidor.


scannerMode - Escolha a maneira de executar a análise
string. Obrigatórios. Valores permitidos: MSBuild (Integrar com MSBuild), Other (Integrar com Maven ou Gradle) CLI (Usar scanner autônomo). Valor padrão: MSBuild.

MSBuild

  • Coloque essa tarefa antes da tarefa do MSBuild.
  • Adicione a Run Code Analysis tarefa após as tarefas do MSBuild/VSTest.

Maven/Gradle

  • Coloque essa tarefa antes da tarefa Maven/Gradle.
  • Marque a Run SonarQube Analysis caixa de seleção na configuração da tarefa Maven/Gradle.

Others

  • Para outros casos, você pode usar o verificador autônomo (sonar-scanner), definir todas as configurações com essa tarefa e, em seguida, adicionar a Run Code Analysis tarefa.

configMode - Modo
string. Obrigatório quando scannerMode = CLI. Valores permitidos: file (Armazenar configuração com meu código-fonte (sonar-project.properties)) manual (Fornecer configuração manualmente). Valor padrão: file.

Especifica seu método de configuração preferencial.


configFile - Arquivo de configurações
string. Opcional. Use quando scannerMode = CLI && configMode = file. Valor padrão: sonar-project.properties.

Especifica as definições de configuração e as propriedades do projeto. Saiba mais sobre a Extensão SonarQube para Azure DevOps.


cliProjectKey - Chave do Projeto
string. Obrigatório quando scannerMode = CLI && configMode = manual.

Especifica a chave exclusiva do projeto SonarQube. Por exemplo, sonar.projectKey.


projectKey - Chave do Projeto
string. Obrigatório quando scannerMode = MSBuild.

Especifica a chave exclusiva do projeto SonarQube. Por exemplo, sonar.projectKey.


cliProjectName - Nome do Projeto
string. Opcional. Use quando scannerMode = CLI && configMode = manual.

Especifica o nome do projeto SonarQube. Por exemplo, sonar.projectName.


projectName - Nome do Projeto
string. Opcional. Use quando scannerMode = MSBuild.

Especifica o nome do projeto SonarQube. Por exemplo, sonar.projectName.


cliProjectVersion - Versão do Projeto
string. Opcional. Use quando scannerMode = CLI && configMode = manual. Valor padrão: 1.0.

Especifica a versão do projeto SonarQube. Por exemplo, sonar.projectVersion.


projectVersion - Versão do Projeto
string. Opcional. Use quando scannerMode = MSBuild. Valor padrão: 1.0.

Especifica a versão do projeto SonarQube. Por exemplo, sonar.projectVersion.


cliSources - Raiz do diretório de fontes
string. Obrigatório quando scannerMode = CLI && configMode = manual. Valor padrão: ..

Especifica o caminho para o diretório raiz que contém arquivos de origem. Esse valor é definido como a sonar.sources propriedade SonarQube.


extraProperties - Propriedades adicionais
string. Valor padrão: # Additional properties that will be passed to the scanner, \n# Put one key=value per line, example:\n# sonar.exclusions=**/*.bin.

Especifica propriedades adicionais a serem passadas para o verificador. Especifique cada key=value par em uma nova linha.


Opções de controle de tarefa

Todas as tarefas têm opções de controle além de suas entradas de tarefa. Para obter mais informações, consulte Opções de controle e propriedades comuns da tarefa.

Variáveis de saída

Nenhum.

Comentários

  • Suporte a projetos que não são do MSBuild: Essa tarefa também pode configurar a análise para projetos que não são do MSBuild.

Requisitos

Requisito Descrição
Tipos de pipeline YAML, build clássico
Executa em Agent, DeploymentGroup
Demandas Nenhum
Funcionalidades Essa tarefa não atende a nenhuma demanda para tarefas subsequentes no trabalho.
Restrições de comando Qualquer
Variáveis configuráveis Qualquer
Versão do agente 1.95.1 ou superior
Categoria da tarefa Build

Confira também