Partilhar via

SonarQubePrepare@6 - Tarefa Preparar Configuração de Análise v6

  • Artigo

Prepare a configuração da análise SonarQube.

Observação

As tarefas SonarQube fazem parte da extensão SonarQube para Azure DevOps, que é pré-instalada nos Serviços de DevOps do Azure. Para obter mais informações e suporte para tarefas SonarQube e SonarQube, consulte extensão SonarQube para Azure DevOps, SonarQube - Visual Studio Marketplacee Sonar Community.

Sintaxe

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

Insumos

SonarQube - de ponto de extremidade do servidor SonarQube
string. Necessário.

Selecione o ponto de extremidade do servidor SonarQube para seu projeto. Para criar um, clique no link Gerenciar e crie um novo SonarQube Server Endpoint, insira o url e o token do servidor.


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

MSBuild

  • Coloque esta tarefa antes da tarefa do MSBuild
  • Adicione a tarefa 'Executar análise de código' após as tarefas MSBuild/VSTest

Maven/Gradle

  • Coloque esta tarefa antes da tarefa Maven/Gradle
  • Marque a caixa de seleção 'Executar Análise SonarQube' na configuração da tarefa Maven/Gradle.

Outros

Para outros casos, você pode usar o scanner autônomo (sonar-scanner) e definir todas as configurações com esta tarefa e, em seguida, adicionar a tarefa 'Executar análise de código'.


msBuildVersion - Scanner MSBuild Versão
string. Opcional. Use quando scannerMode = MSBuild.

Especifique a versão do mecanismo de varredura MSBuild a ser usada. As versões podem ser localizadas aqui.


cliVersion - Scanner CLI Versão
string. Opcional. Use quando scannerMode = CLI.

Especifique a versão do mecanismo de varredura da CLI a ser usada. As versões podem ser localizadas aqui.


Modo configMode -
string. Necessá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.

Escolha o seu método de configuração preferido.


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

Mais informações estão disponíveis aqui.


cliProjectKey - Chave do Projeto
string. Necessário quando scannerMode = CLI && configMode = manual.

A chave única do projeto SonarQube, ou seja, sonar.projectKey.


projectKey - Chave do Projeto
string. Necessário quando scannerMode = MSBuild.

A chave única do projeto SonarQube, ou seja, sonar.projectKey.


cliProjectName - nome do projeto
string. Opcional. Use quando scannerMode = CLI && configMode = manual.

O nome do projeto SonarQube, ou seja, sonar.projectName.


projectName - nome do projeto
string. Opcional. Use quando scannerMode = MSBuild.

O nome do projeto SonarQube, ou seja, sonar.projectName.


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

A versão do projeto SonarQube, ou seja, sonar.projectVersion.


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

A versão do projeto SonarQube, ou seja, sonar.projectVersion.


cliSources - raiz do diretório Sources
string. Necessário quando scannerMode = CLI && configMode = manual. Valor padrão: ..

Caminho para o diretório raiz que contém os arquivos de origem. Esse valor é definido como a propriedade sonar.sources 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.

Propriedades adicionais ser passadas para o scanner. Especifique cada par chave=valor em uma nova linha.


Opções de controlo de tarefas

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

Variáveis de saída

Nenhuma.

Comentários

Observação

As tarefas SonarQube fazem parte da extensão SonarQube para Azure DevOps, que é pré-instalada nos Serviços de DevOps do Azure. Para obter mais informações e suporte para tarefas SonarQube e SonarQube, consulte extensão SonarQube para Azure DevOps, SonarQube - Visual Studio Marketplacee Sonar Community.

Requerimentos

Exigência Descrição
Tipos de pipeline YAML, construção clássica
Funciona em Agente, DeploymentGroup
Exigências Nenhum
Capacidades Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes no trabalho.
Restrições de comando Qualquer
Variáveis configuráveis Qualquer
Versão do agente 3.218.0 ou superior
Categoria de tarefa Construir