Maven@4 - Tarefa Maven v4

Crie, teste e implante com o Apache Maven.

Sintaxe

# Maven v4
# Build, test, and deploy with Apache Maven.
- task: Maven@4
  inputs:
    #azureSubscription: # string. Alias: ConnectedServiceName. Azure Resource Manager connection. 
    mavenPOMFile: 'pom.xml' # string. Required. Maven POM file. Default: pom.xml.
    #goals: 'package' # string. Goal(s). Default: package.
    #options: # string. Options. 
  # JUnit Test Results
    #publishJUnitResults: true # boolean. Publish to Azure Pipelines. Default: true.
    testResultsFiles: '**/surefire-reports/TEST-*.xml' # string. Required when publishJUnitResults = true. Test results files. Default: **/surefire-reports/TEST-*.xml.
    #testRunTitle: # string. Optional. Use when publishJUnitResults = true. Test run title. 
    #allowBrokenSymlinks: true # boolean. Alias: allowBrokenSymbolicLinks. Optional. Use when publishJUnitResults = true. Allow broken symbolic links. Default: true.
  # Code Coverage
    #codeCoverageToolOption: 'None' # 'None' | 'Cobertura' | 'JaCoCo'. Alias: codeCoverageTool. Code coverage tool. Default: None.
    #codeCoverageClassFilter: # string. Alias: classFilter. Optional. Use when codeCoverageTool != None. Class inclusion/exclusion filters. 
    #codeCoverageClassFilesDirectories: # string. Alias: classFilesDirectories. Optional. Use when codeCoverageTool = JaCoCo. Class files directories. 
    #codeCoverageSourceDirectories: # string. Alias: srcDirectories. Optional. Use when codeCoverageTool = JaCoCo. Source files directories. 
    #codeCoverageFailIfEmpty: false # boolean. Alias: failIfCoverageEmpty. Optional. Use when codeCoverageTool != None. Fail when code coverage results are missing. Default: false.
    #codeCoverageRestoreOriginalPomXml: false # boolean. Alias: restoreOriginalPomXml. Optional. Use when codeCoverageTool != None. Restore original pom.xml after task execution. Default: false.
  # Advanced
    javaHomeOption: 'JDKVersion' # 'JDKVersion' | 'Path'. Alias: javaHomeSelection. Required. Set JAVA_HOME by. Default: JDKVersion.
    #jdkVersionOption: 'default' # 'default' | '1.17' | '1.11' | '1.10' | '1.9' | '1.8' | '1.7' | '1.6'. Alias: jdkVersion. Optional. Use when javaHomeSelection = JDKVersion. JDK version. Default: default.
    #jdkDirectory: # string. Alias: jdkUserInputPath. Required when javaHomeSelection = Path. JDK path. 
    #jdkArchitectureOption: 'x64' # 'x86' | 'x64'. Alias: jdkArchitecture. Optional. Use when jdkVersion != default. JDK architecture. Default: x64.
    mavenVersionOption: 'Default' # 'Default' | 'Path'. Alias: mavenVersionSelection. Required. Maven version. Default: Default.
    #mavenDirectory: # string. Alias: mavenPath. Required when mavenVersionSelection = Path. Maven path. 
    #mavenSetM2Home: false # boolean. Optional. Use when mavenVersionSelection = Path. Set M2_HOME variable. Default: false.
    #mavenOptions: '-Xmx1024m' # string. Alias: mavenOpts. Set MAVEN_OPTS to. Default: -Xmx1024m.
    #mavenAuthenticateFeed: false # boolean. Alias: mavenFeedAuthenticate. Authenticate with Artifacts feeds. Default: false.
    #effectivePomSkip: false # boolean. Alias: skipEffectivePom. Skip generating effective POM while authenticating with Artifacts feeds. Default: false.
  # Code Analysis
    #sonarQubeRunAnalysis: false # boolean. Alias: sqAnalysisEnabled. Run SonarQube or SonarCloud analysis. Default: false.
    #isJacocoCoverageReportXML: false # boolean. Optional. Use when sqAnalysisEnabled = true && codeCoverageTool = JaCoCo. Use XML Jacoco reports for SonarQube analysis. Default: false.
    #sqMavenPluginVersionChoice: 'latest' # 'latest' | 'pom'. Required when sqAnalysisEnabled = true. SonarQube scanner for Maven version. Default: latest.
    #checkStyleRunAnalysis: false # boolean. Alias: checkstyleAnalysisEnabled. Run Checkstyle. Default: false.
    #pmdRunAnalysis: false # boolean. Alias: pmdAnalysisEnabled. Run PMD. Default: false.
    #findBugsRunAnalysis: false # boolean. Alias: findbugsAnalysisEnabled. Run FindBugs. Default: false.
    #spotBugsRunAnalysis: false # boolean. Alias: spotBugsAnalysisEnabled. Run SpotBugs analysis. Default: false.
    #spotBugsVersion: '4.5.3.0' # string. Alias: spotBugsMavenPluginVersion. Optional. Use when spotBugsAnalysisEnabled = true. Version number. Default: 4.5.3.0.
    #spotBugsGoal: 'spotbugs' # 'spotbugs' | 'check'. Optional. Use when spotBugsAnalysisEnabled = true. The goal for the spotbugs plugin. Default: spotbugs.
    #failWhenBugsFound: true # boolean. Alias: spotBugsFailWhenBugsFound | sbFailWhenBugsFound. Optional. Use when spotBugsAnalysisEnabled = true && spotBugsGoal = check. Fail when bugs are found with spotbugs:check. Default: true.

Insumos

azureSubscription - de conexão do Azure Resource Manager
Alias de entrada: ConnectedServiceName. string.

Especifique uma conexão de serviço do Azure Resource Manager configurada com federação de identidade de carga de trabalho para usar AzurePipelinesCredential em testes de integração. Para obter mais informações, consulte Usar AzurePipelinesCredential em testes de integração.

Observação

Essa entrada oferece suporte apenas a conexões de serviço ARM configuradas para usar a federação de identidades de carga de trabalho.

mavenPOMFile - do arquivo POM Maven
string. Necessário. Valor padrão: pom.xml.

Especifica o caminho relativo da raiz do repositório para o arquivo Maven POM. Consulte Introdução ao POM para obter mais informações.

goals - Objetivo(s)
string. Valor padrão: package.

(Opcional) Defina como package para compilar seu código e empacotá-lo em um arquivo .war. Se você deixar esse argumento em branco, a compilação falhará. Consulte Introdução ao do ciclo de vida de compilação do Maven para obter mais informações.

options - Opções
string.

(Opcional) Especifica as opções de linha de comando do Maven que você deseja usar.

publishJUnitResults - Publicar no Azure Pipelines
boolean. Valor padrão: true.

Especifica a opção para publicar os resultados do teste JUnit produzidos pela compilação Maven no Azure Pipelines. Cada arquivo de resultados de teste correspondente Test Results Files será publicado como uma execução de teste no Azure Pipelines.

testResultsFiles - Arquivos de resultados de teste
string. Necessário quando publishJUnitResults = true. Valor padrão: **/surefire-reports/TEST-*.xml.

Especifica o caminho e o padrão dos arquivos de resultados de teste a serem publicados.
Curingas podem ser usados.
Mais informações sobre padrões de correspondência de arquivos.
Por exemplo, **/TEST-*.xml para todos os arquivos XML cujo nome começa com TEST-. Se nenhum caminho raiz for especificado, os arquivos serão correspondidos abaixo do diretório de trabalho padrão, cujo valor está disponível na variável $(System.DefaultWorkingDirectory). Por exemplo, um valor de **/TEST-*.xml realmente resultará em arquivos correspondentes de $(System.DefaultWorkingDirectory)/**/TEST-*.xml.

testRunTitle - Título da execução de teste
string. Opcional. Use quando publishJUnitResults = true.

Especifica um nome para a execução de teste.

allowBrokenSymlinks - Permitir links simbólicos quebrados
Alias de entrada: allowBrokenSymbolicLinks. boolean. Opcional. Use quando publishJUnitResults = true. Valor padrão: true.

Se definido como false, falhará na compilação quando a tarefa encontrar um link simbólico quebrado durante a publicação do resultado dos testes.

codeCoverageToolOption - Ferramenta de cobertura de código
Alias de entrada: codeCoverageTool. string. Valores permitidos: None, Cobertura, JaCoCo. Valor padrão: None.

Especifica a ferramenta de cobertura de código. Habilitar a cobertura de código insere a meta limpa na lista de metas do Maven quando o Maven é executado.

codeCoverageClassFilter - Filtros de inclusão/exclusão de classe
Alias de entrada: classFilter. string. Opcional. Use quando codeCoverageTool != None.

Especifica uma lista separada por vírgulas de filtros para incluir ou excluir classes da coleta de cobertura de código. Por exemplo, +:com.*,+:org.*,-:my.app*.*.

codeCoverageClassFilesDirectories - Diretórios de arquivos de classe
Alias de entrada: classFilesDirectories. string. Opcional. Use quando codeCoverageTool = JaCoCo.

Este campo é obrigatório para um projeto multimódulo.
Especifica uma lista separada por vírgulas de caminhos relativos do arquivo Maven POM para diretórios contendo arquivos de classe e arquivos (JAR, WAR, etc.). A cobertura de código é relatada para arquivos de classe nesses diretórios. Por exemplo, target/classes,target/testClasses.

codeCoverageSourceDirectories - Diretórios de arquivos de origem
Alias de entrada: srcDirectories. string. Opcional. Use quando codeCoverageTool = JaCoCo.

Este campo é obrigatório para um projeto multimódulo.
Especifica uma lista separada por vírgulas de caminhos relativos do arquivo Maven POM para diretórios de código-fonte. Os relatórios de cobertura de código usam-nos para realçar o código-fonte. Por exemplo, src/java,src/Test.

codeCoverageFailIfEmpty - Falha quando os resultados da cobertura de código estão faltando
Alias de entrada: failIfCoverageEmpty. boolean. Opcional. Use quando codeCoverageTool != None. Valor padrão: false.

Falha na compilação se a cobertura do código não produziu nenhum resultado para publicar.

codeCoverageRestoreOriginalPomXml - Restaurar o pom.xml original após a execução da tarefa
Alias de entrada: restoreOriginalPomXml. boolean. Opcional. Use quando codeCoverageTool != None. Valor padrão: false.

A cobertura de código modifica pom.xml para produzir resultados. Use esta opção se precisar manter o pom.xmloriginal.

javaHomeOption - set JAVA_HOME por
Alias de entrada: javaHomeSelection. string. Necessário. Valores permitidos: JDKVersion (Versão JDK), Path. Valor padrão: JDKVersion.

Define JAVA_HOME selecionando uma versão do JDK que será descoberta durante as compilações ou inserindo manualmente um caminho JDK. Se você já tiver o Java instalado na máquina do agente, poderá especificá-lo configurando javaHomeOption como path e jdkDirectory como um caminho para o diretório instalado do JDK.

jdkVersionOption - versão JDK
Alias de entrada: jdkVersion. string. Opcional. Use quando javaHomeSelection = JDKVersion. Valores permitidos: default, 1.17 (JDK 17), 1.11 (JDK 11), 1.10 (JDK 10 (sem suporte)), 1.9 (JDK 9 (sem suporte)), 1.8 (JDK 8), 1.7 (JDK 7) 1.6 (JDK 6 (sem suporte)). Valor padrão: default.

Tenta descobrir o caminho para a versão selecionada do JDK e define JAVA_HOME de acordo.
Nota: Se estiver sendo executado em um agente que não esteja hospedado pela Microsoft, e a versão Java solicitada não for a indicada pela variável JAVA_HOME definida na máquina do agente, a tarefa contará com a variável JAVA_HOME_{version}_{arch} (por exemplo: JAVA_HOME_8_X64) para localizar o JDK necessário. Certifique-se de que essa variável esteja definida em agentes auto-hospedados para qualquer versão e arquitetura do JDK que possa ser solicitada por este parâmetro e/ou por jdkArchitecture.

jdkDirectory - caminho JDK
Alias de entrada: jdkUserInputPath. string. Necessário quando javaHomeSelection = Path.

Define JAVA_HOME para o caminho determinado.

jdkArchitectureOption - arquitetura JDK
Alias de entrada: jdkArchitecture. string. Opcional. Use quando jdkVersion != default. Valores permitidos: x86, x64. Valor padrão: x64.

Fornece a arquitetura (x86, x64) do JDK.

mavenVersionOption - Maven versão
Alias de entrada: mavenVersionSelection. string. Necessário. Valores permitidos: Default, Path (Caminho personalizado). Valor padrão: Default.

Especifica a versão padrão do Maven ou a versão no caminho personalizado especificado.

mavenDirectory - Caminho Maven
Alias de entrada: mavenPath. string. Necessário quando mavenVersionSelection = Path.

Fornece o caminho personalizado para a instalação do Maven (por exemplo: /usr/share/maven).

mavenSetM2Home - Definir M2_HOME variável
boolean. Opcional. Use quando mavenVersionSelection = Path. Valor padrão: false.

Define a variável M2_HOME como um caminho de instalação personalizado do Maven.

mavenOptions - Definir MAVEN_OPTS para
Alias de entrada: mavenOpts. string. Valor padrão: -Xmx1024m.

Define a variável de ambiente MAVEN_OPTS, que é usada para enviar argumentos de linha de comando para iniciar a JVM. O sinalizador -Xmx especifica a memória máxima disponível para a JVM.

mavenAuthenticateFeed - Autenticar com feeds de artefatos
Alias de entrada: mavenFeedAuthenticate. boolean. Valor padrão: false.

Autentica automaticamente com feeds de Artefatos do Azure. Se os feeds de Artefatos não estiverem em uso, desmarque essa opção para compilações mais rápidas.

effectivePomSkip - Ignore a geração de POM eficaz durante a autenticação com feeds de artefatos
Alias de entrada: skipEffectivePom. boolean. Valor padrão: false.

Autentica com feeds de Artefatos usando somente o POM.

sonarQubeRunAnalysis - Execute o de análise SonarQube ou SonarCloud
Alias de entrada: sqAnalysisEnabled. boolean. Valor padrão: false.

Esta opção mudou de usar a versão 1 da tarefa Maven para usar as extensões de mercado SonarQube e SonarCloud.
Habilite essa opção para executar de análise SonarQube ou SonarCloud depois de executar metas no campo Metas . O instalar ou pacote objetivo deve ser executado primeiro. Antes dessa tarefa do Maven, você também deve adicionar uma tarefa Preparar Configuração de Análise de uma das extensões para o pipeline de compilação.

isJacocoCoverageReportXML - Usar relatórios XML Jacoco para análise SonarQube
boolean. Opcional. Use quando sqAnalysisEnabled = true && codeCoverageTool = JaCoCo. Valor padrão: false.

Usa relatórios XML Jacoco para análise SonarQube. Saiba mais sobre relatórios de teste.

sqMavenPluginVersionChoice - scanner SonarQube para Maven versão
string. Necessário quando sqAnalysisEnabled = true. Valores permitidos: latest (Usar versão mais recente) pom (Usar versão declarada em seu pom.xml). Valor padrão: latest.

Especifica a versão do plug-in SonarQube Maven a ser usada. Você pode usar a versão mais recente ou confiar na versão em seu pom.xml.

checkStyleRunAnalysis - Executar Checkstyle
Alias de entrada: checkstyleAnalysisEnabled. boolean. Valor padrão: false.

Executa a ferramenta Checkstyle com as verificações Sun padrão. Se nenhuma configuração Checkstyle for especificada no arquivo pom.xml, as verificações Sun padrão serão usadas. Os resultados são carregados como artefatos de construção.

pmdRunAnalysis - Executar PMD
Alias de entrada: pmdAnalysisEnabled. boolean. Valor padrão: false.

Usa a ferramenta de análise estática PMD para procurar bugs no código. Os resultados são carregados como artefatos de construção.

findBugsRunAnalysis - Executar FindBugs
Alias de entrada: findbugsAnalysisEnabled. boolean. Valor padrão: false.

Usa a ferramenta de análise estática FindBugs para procurar bugs no código. Os resultados são carregados como artefatos de construção.

spotBugsRunAnalysis - Executar de análise de SpotBugs
Alias de entrada: spotBugsAnalysisEnabled. boolean. Valor padrão: false.

Habilite esta opção para executar o plug-in de análise de código SpotBugs. Mais informações sobre o plugin SpotBugs Maven.

spotBugsVersion - Número da versão
Alias de entrada: spotBugsMavenPluginVersion. string. Opcional. Use quando spotBugsAnalysisEnabled = true. Valor padrão: 4.5.3.0.

Saiba mais sobre as versões disponíveis do SpotBugs.

spotBugsGoal - O objetivo para o plugin spotbugs
string. Opcional. Use quando spotBugsAnalysisEnabled = true. Valores permitidos: spotbugs ("spotbugs" - Cria um relatório sobre bugs encontrados), check ("check" - Pipeline falha se bugs foram detetados). Valor padrão: spotbugs.

Especifica o objetivo do plugin. Saiba mais sobre objetivos do SpotBugs.

failWhenBugsFound - Falha quando bugs são encontrados com spotbugs:verifique
Alias de entrada: spotBugsFailWhenBugsFound | sbFailWhenBugsFound. boolean. Opcional. Use quando spotBugsAnalysisEnabled = true && spotBugsGoal = check. Valor padrão: true.

Falha quando bugs são encontrados se Verificar Meta for especificado. Saiba mais sobre detalhes do parâmetro SpotBug.

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

A configuração da análise SonarQube foi movida para as extensões SonarQube ou SonarCloud na tarefa Prepare Analysis Configuration.

Importante

Ao usar a opção -q em seu MAVEN_OPTS, um pom efetivo não será gerado corretamente e os feeds de Artefatos do Azure podem não conseguir ser autenticados.

Importante

Se a versão do JDK que você deseja usar já estiver instalada no seu agente, defina javaHomeOption como path e defina o jdkDirectory para o caminho da versão do JDK. Essas opções definem a variável de ambiente JAVA_HOME_11_X64, que é exigida pela tarefa Maven. Esta variável de ambiente é definida automaticamente se você estiver usando a tarefa do instalador da Java Tool.

Usar AzurePipelinesCredential em testes de integração

As bibliotecas de Identidade do Azure para .NET, C++, Go, Java, JavaScript e Python fornecem suporte parade federação de identidades de carga de trabalho, para que o código executado a partir das tarefas AzureCLI@2 e AzurePowerShell@5 possa se autenticar com a ID do Microsoft Entra (por exemplo, para acessar o Azure) usando a classe AzurePipelinesCredential.

Muitos clientes estão usando bibliotecas de cliente do SDK do Azure em testes de integração invocados de outras tarefas. As tarefas DotNetCoreCLI@2, Maven@4 e VSTest@3 podem acessar recursos do Azure usando a classe AzurePipelinesCredential.

Você pode definir a propriedade connectedService para uma conexão de serviço do Azure configurada com federação de identidade de carga de trabalho. O AzurePipelinesCredential exige que SYSTEM_ACCESSTOKEN sejam definidos.

O exemplo a seguir mostra a entrada de connectedService na tarefa DotNetCoreCLI@2. VSTest@3 e Maven@4 uso é semelhante.

- task: DotNetCoreCLI@2
  inputs:
    command: 'run'
    connectedService: <Azure service connection configured with workload identity federation>
  env:
    SYSTEM_ACCESSTOKEN: $(System.AccessToken)

Para obter mais informações sobre AzurePipelinesCredential, consulte este Melhorar a postura de segurança em conexões de serviço do Azure com AzurePipelinesCredential.

Perguntas Frequentes

Eu tenho um projeto multi-módulo, mas minha compilação está falhando. O que devo verificar?

Certifique-se de ter especificado #codeCoverageClassFilesDirectories e #codeCoverageSourceDirectories como uma entrada de tarefa. Esses dois parâmetros são opcionais para um projeto de módulo único, mas são necessários para projetos de vários módulos.

Exemplos

• Crie e implante seu aplicativo Java em um aplicativo Web do Azure.

Requerimentos

Exigência	Descrição
Tipos de pipeline	YAML, Construção clássica, Versão clássica
Funciona em	Agente, DeploymentGroup
Exigências	Os agentes auto-hospedados devem ter recursos que correspondam às seguintes demandas executar trabalhos que usam essa tarefa: maven
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	1.89.0 ou superior
Categoria de tarefa	Construir

Ver também

• Maven autenticar
• Publicar artefatos do Maven com o Azure Pipelines
• do instalador da ferramenta Java
• Construir aplicativos Java