Maven@3 - Tarefa maven v3

Utilize esta tarefa para criar, testar e implementar com o Apache Maven.

Syntax

# Maven v3
# Build, test, and deploy with Apache Maven.
- task: Maven@3
  inputs:
    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.

Entradas

mavenPOMFile - Ficheiro POM do Maven
string. Obrigatório. Valor predefinido: pom.xml.

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

goals - Objetivos
string. Valor predefinido: package.

(Opcional) Defina para package compilar o seu código e empacotá-lo num ficheiro .war. Se deixar este argumento em branco, a compilação falhará. Veja Introdução ao ciclo de vida da compilação do Maven para obter mais informações.

options - Opções
string.

(Opcional) Especifica as opções de linha de comandos do Maven que pretende utilizar.

publishJUnitResults - Publicar nos Pipelines do Azure
boolean. Valor predefinido: true.

Especifica a opção para publicar os resultados do teste JUnit produzidos pela compilação do Maven nos Pipelines do Azure. Cada correspondência Test Results Files de ficheiros de resultados de teste será publicada como uma execução de teste nos Pipelines do Azure.

testResultsFiles - Testar ficheiros de resultados
string. Necessário quando publishJUnitResults = true. Valor predefinido: **/surefire-reports/TEST-*.xml.

Especifica o caminho e o padrão dos ficheiros de resultados de teste a publicar.
Podem ser utilizados carateres universais.
Mais informações sobre padrões de correspondência de ficheiros.
Por exemplo, **/TEST-*.xml para todos os ficheiros XML cujo nome começa com TEST-. Se não for especificado nenhum caminho de raiz, os ficheiros serão correspondidos por baixo do diretório de trabalho predefinido, cuja função está disponível na variável $(System.DefaultWorkingDirectory). Por exemplo, um valor de **/TEST-*.xml irá resultar em ficheiros correspondentes de $(System.DefaultWorkingDirectory)/**/TEST-*.xml.

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

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

allowBrokenSymlinks - Permitir ligações simbólicas quebradas
Alias de entrada: allowBrokenSymbolicLinks. boolean. Opcional. Utilize quando publishJUnitResults = true. Valor predefinido: true.

Se definida como false, falha na compilação quando a tarefa encontra uma ligação simbólica quebrada enquanto publica o resultado dos testes.

codeCoverageToolOption - Ferramenta de cobertura de código
Alias de entrada: codeCoverageTool. string. Valores permitidos: None, , CoberturaJaCoCo. Valor predefinido: None.

Especifica a ferramenta de cobertura de código. Ativar a cobertura do código insere o objetivo limpo na lista de objetivos do Maven quando o Maven é executado.

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

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

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

Este campo é necessário para um projeto de vários módulos.
Especifica uma lista separada por vírgulas de caminhos relativos do ficheiro POM do Maven para diretórios que contêm ficheiros de classe e ficheiros de arquivo (JAR, WAR, etc.). A cobertura do código é comunicada para ficheiros de classe nestes diretórios. Por exemplo, target/classes,target/testClasses.

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

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

codeCoverageFailIfEmpty - Falha quando os resultados da cobertura do código estão em falta
Alias de entrada: failIfCoverageEmpty. boolean. Opcional. Utilize quando codeCoverageTool != None. Valor predefinido: false.

Falha na compilação se a cobertura do código não produzir resultados para publicar.

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

A cobertura do código é pom.xml modificada para produzir resultados. Utilize esta opção se precisar de manter o original pom.xml.

javaHomeOption - Definir JAVA_HOME por
Alias de entrada: javaHomeSelection. string. Obrigatório. Valores permitidos: JDKVersion (Versão JDK), Path. Valor predefinido: JDKVersion.

Define JAVA_HOME ao selecionar uma versão JDK que será detetada durante as compilações ou ao introduzir manualmente um caminho JDK. Se já tiver o Java instalado no computador do agente, pode especificá-lo ao configurar javaHomeOption como path e jdkDirectory como um caminho para o diretório instalado do JDK.

jdkVersionOption - Versão do JDK
Alias de entrada: jdkVersion. string. Opcional. Utilize 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 predefinido: default.

Tenta detetar o caminho para a versão do JDK selecionada e define JAVA_HOME em conformidade.
Nota: Se estiver em execução num agente que não esteja alojado pela Microsoft e a versão de Java pedida não for a indicada pela JAVA_HOME variável definida no computador do agente, a tarefa irá depender da variável JAVA_HOME_{version}_{arch} (por exemplo: JAVA_HOME_8_X64) para localizar o JDK necessário. Certifique-se de que esta variável está definida em agentes autoalojados para qualquer versão e arquitetura do JDK que possa ser pedida por este parâmetro e/ou por jdkArchitecture.

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

Define JAVA_HOME para o caminho especificado.

jdkArchitectureOption - Arquitetura JDK
Alias de entrada: jdkArchitecture. string. Opcional. Utilize quando jdkVersion != default. Valores permitidos: x86, x64. Valor predefinido: x64.

Fornece a arquitetura (x86, x64) do JDK.

mavenVersionOption - Versão do Maven
Alias de entrada: mavenVersionSelection. string. Obrigatório. Valores permitidos: Default, Path (Caminho Personalizado). Valor predefinido: Default.

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

mavenDirectory - Caminho do 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 variável de M2_HOME
boolean. Opcional. Utilize quando mavenVersionSelection = Path. Valor predefinido: false.

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

mavenOptions - Definir MAVEN_OPTS como
Alias de entrada: mavenOpts. string. Valor predefinido: -Xmx1024m.

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

mavenAuthenticateFeed - Autenticar com feeds de Artefactos
Alias de entrada: mavenFeedAuthenticate. boolean. Valor predefinido: false.

Autentica-se automaticamente com feeds de Artefactos do Azure. Se os feeds de Artefactos não estiverem a ser utilizados, desselecione esta opção para compilações mais rápidas.

effectivePomSkip - Ignorar a geração de POM eficaz durante a autenticação com feeds de Artefactos
Alias de entrada: skipEffectivePom. boolean. Valor predefinido: false.

Autentica-se com feeds de Artefactos utilizando apenas o POM.

sonarQubeRunAnalysis - Executar a análise do SonarQube ou do SonarCloud
Alias de entrada: sqAnalysisEnabled. boolean. Valor predefinido: false.

Esta opção passou da utilização da versão 1 da tarefa maven para a utilização das extensões do marketplace SonarQube e SonarCloud .
Ative esta opção para executar a análise sonarQube ou SonarCloud após executar objetivos no campo Objetivos . O objetivo de instalação ou pacote deve ser executado primeiro. Antes desta tarefa do Maven, também tem de adicionar uma tarefa Preparar Configuração de Análise a partir de uma das extensões ao pipeline de compilação.

isJacocoCoverageReportXML - Utilizar relatórios XML Jacoco para análise de SonarQube
boolean. Opcional. Utilize quando sqAnalysisEnabled = true && codeCoverageTool = JaCoCo. Valor predefinido: false.

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

sqMavenPluginVersionChoice - SonarQube scanner for Maven version (Scanner SonarQube para a versão do Maven)
string. Necessário quando sqAnalysisEnabled = true. Valores permitidos: latest (Utilize a versão mais recente) pom (Utilize a versão declarada no seu pom.xml). Valor predefinido: latest.

Especifica a versão do plug-in SonarQube Maven a utilizar. Pode utilizar a versão mais recente ou depender da versão no seu pom.xml.

checkStyleRunAnalysis - Executar Estilo de Verificação
Alias de entrada: checkstyleAnalysisEnabled. boolean. Valor predefinido: false.

Executa a ferramenta Checkstyle com as verificações Sun predefinidas. Se não for especificada nenhuma configuração checkstyle no pom.xml ficheiro, são utilizadas verificações Sun predefinidas. Os resultados são carregados como artefactos de compilação.

pmdRunAnalysis - Executar PMD
Alias de entrada: pmdAnalysisEnabled. boolean. Valor predefinido: false.

Utiliza a ferramenta de análise estática PMD para procurar erros no código. Os resultados são carregados como artefactos de compilação.

findBugsRunAnalysis - Executar FindBugs
Alias de entrada: findbugsAnalysisEnabled. boolean. Valor predefinido: false.

Utiliza a ferramenta de análise estática FindBugs para procurar erros no código. Os resultados são carregados como artefactos de compilação.

spotBugsRunAnalysis - Executar a análise de SpotBugs
Alias de entrada: spotBugsAnalysisEnabled. boolean. Valor predefinido: false.

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

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

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

spotBugsGoal - O objetivo do plug-in spotbugs
string. Opcional. Utilize quando spotBugsAnalysisEnabled = true. Valores permitidos: spotbugs ("spotbugs" – cria um relatório sobre erros encontrados), check ("verificar" – O pipeline falha se forem detetados erros). Valor predefinido: spotbugs.

Especifica o objetivo do plug-in. Saiba mais sobre os objetivos de SpotBugs.

failWhenBugsFound - Falha quando são encontrados erros com spotbugs:check
Alias de entrada: spotBugsFailWhenBugsFound | sbFailWhenBugsFound. boolean. Opcional. Utilize quando spotBugsAnalysisEnabled = true && spotBugsGoal = check. Valor predefinido: true.

Falha quando são encontrados erros se a opção Verificar Objetivo for especificada. Saiba mais sobre os detalhes do parâmetro SpotBug.

Opções de controlo de tarefas

Todas as tarefas têm opções de controlo para além das entradas de tarefas. Para obter mais informações, veja Opções de controlo e propriedades de tarefas comuns.

Variáveis de saída

Nenhum.

Observações

A configuração da análise do SonarQube foi movida para as extensões SonarQube ou SonarCloud na tarefa Preparar a Configuração da Análise.

Importante

Ao utilizar a opção -q no seu MAVEN_OPTS, um pom eficaz não será gerado corretamente e os feeds de Artefactos do Azure podem não ser capazes de ser autenticados.

Importante

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

FAQ

Tenho um projeto com vários módulos, mas a minha compilação está a falhar. O que devo verificar?

Certifique-se de que especificou #codeCoverageClassFilesDirectories e #codeCoverageSourceDirectories como entrada de tarefas. Estes dois parâmetros são opcionais para um único projeto de módulo, mas são necessários para projetos de vários módulos.

Exemplos

• Criar e Implementar a sua aplicação Java numa Aplicação Web do Azure.

Requisitos

Requisito	Description
Tipos de pipeline	YAML, Compilação clássica, Versão clássica
É executado em	Agente, DeploymentGroup
Exigências	Os agentes autoalojados têm de ter capacidades que correspondam às seguintes exigências para executar tarefas que utilizam esta tarefa: maven
Capacidades	Esta tarefa não satisfaz quaisquer exigências para tarefas subsequentes na tarefa.
Restrições de comandos	Qualquer
Variáveis de tabelas definidas	Qualquer
Versão do agente	1.89.0 ou superior
Categoria da tarefa	Compilar

Ver também

• Autenticar maven
• Publicar artefactos do Maven com o Azure Pipelines
• Instalador de Ferramentas Java
• Compilar aplicações Java