Maven@2 - Tarefa maven v2

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

Syntax

# Maven v2
# Build, test, and deploy with Apache Maven.
- task: Maven@2
  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: '**/TEST-*.xml' # string. Required when publishJUnitResults = true. Test results files. Default: **/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: true # boolean. Alias: mavenFeedAuthenticate. Authenticate with Artifacts feeds. Default: true.
  # 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.

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.

goals - Objetivos
string. Valor predefinido: package.

options - Opções
string.

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: **/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.

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

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.

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.

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

Define JAVA_HOME para o caminho especificado.

jdkArchitectureOption - Arquitetura do 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.

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

Especifica 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 para um caminho de instalação personalizado do Maven.

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

Define a MAVEN_OPTS variável de 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: true.

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

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

Esta opção passou de utilizar a versão 1 da tarefa do Maven para utilizar as extensões do marketplace SonarQube e SonarCloud .
Ative esta opção para executar a análise do SonarQube ou do SonarCloud após executar os objetivos no campo Goals. 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 do 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 o Checkstyle
Alias de entrada: checkstyleAnalysisEnabled. boolean. Valor predefinido: false.

Executa a ferramenta Checkstyle com as 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.

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.

Requisitos

Requisito	Description
Tipos de pipeline	YAML, Compilação clássica, Versão clássica
É executado em	Agent, DeploymentGroup
Exigências	Os agentes autoalojados têm de ter capacidades que correspondam às seguintes exigências para executar tarefas que utilizem 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 definição	Qualquer
Versão do agente	1.89.0 ou superior
Categoria da tarefa	Compilação

Ver também

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