Maven@3 - Tâche Maven v3

Utilisez cette tâche pour générer, tester et déployer avec Apache Maven.

Cette version de la tâche est déconseillée ; utilisez Maven@4.

Syntaxe

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

Entrées

mavenPOMFile - fichier POM Maven
string. Obligatoire. Valeur par défaut : pom.xml.

Spécifie le chemin d’accès relatif de la racine du référentiel au fichier POM Maven. Pour plus d’informations, consultez Présentation du pom.

goals - objectifs
string. Valeur par défaut : package.

(Facultatif) Définissez la valeur package pour compiler votre code et le empaqueter dans un fichier .war. Si vous laissez cet argument vide, la build échoue. Pour plus d’informations, consultez Présentation du cycle de vie de build Maven.

options - options
string.

(Facultatif) Spécifie les options de ligne de commande Maven que vous souhaitez utiliser.

publishJUnitResults - publier sur Azure Pipelines
boolean. Valeur par défaut : true.

Spécifie l’option permettant de publier les résultats des tests JUnit générés par la build Maven sur Azure Pipelines. Chaque fichier de résultats de test correspondant Test Results Files sera publié en tant qu’exécution de test dans Azure Pipelines.

testResultsFiles - fichiers de résultats de test
string. Obligatoire lorsque publishJUnitResults = true. Valeur par défaut : **/surefire-reports/TEST-*.xml.

Spécifie le chemin d’accès et le modèle des fichiers de résultats de test à publier.
Des caractères génériques peuvent être utilisés.
Pour plus d’informations sur les modèles de correspondance de fichiers .
Par exemple, **/TEST-*.xml pour tous les fichiers XML dont le nom commence par TEST-. Si aucun chemin racine n’est spécifié, les fichiers sont mis en correspondance sous le répertoire de travail par défaut, dont la valeur est disponible dans la variable $(System.DefaultWorkingDirectory). Par exemple, une valeur de **/TEST-*.xml entraîne en fait la correspondance de fichiers à partir de $(System.DefaultWorkingDirectory)/**/TEST-*.xml.

testRunTitle - titre d’exécution de test
string. Optionnel. Utilisez quand publishJUnitResults = true.

Spécifie un nom pour l’exécution de test.

allowBrokenSymlinks - Autoriser les liens symboliques rompus
Alias d’entrée : allowBrokenSymbolicLinks. boolean. Optionnel. Utilisez quand publishJUnitResults = true. Valeur par défaut : true.

Si la valeur est définie sur false, échoue la génération lorsque la tâche trouve un lien symbolique rompu lors de la publication du résultat des tests.

codeCoverageToolOption - outil de couverture du code
Alias d’entrée : codeCoverageTool. string. Valeurs autorisées : None, Cobertura, JaCoCo. Valeur par défaut : None.

Spécifie l’outil de couverture du code. L’activation de la couverture du code insère l’objectif propre dans la liste des objectifs Maven lors de l’exécution de Maven.

codeCoverageClassFilter - filtres d’inclusion/exclusion de classe
Alias d’entrée : classFilter. string. Optionnel. Utilisez quand codeCoverageTool != None.

Spécifie une liste séparée par des virgules de filtres pour inclure ou exclure des classes de la collecte de la couverture du code. Par exemple : +:com.*,+:org.*,-:my.app*.*.

répertoires de fichiers de classe codeCoverageClassFilesDirectories -
Alias d’entrée : classFilesDirectories. string. Optionnel. Utilisez quand codeCoverageTool = JaCoCo.

Ce champ est requis pour un projet multimodèle.
Spécifie une liste séparée par des virgules des chemins relatifs du fichier POM Maven vers des répertoires contenant des fichiers de classe et des fichiers d’archive (JAR, WAR, etc.). La couverture du code est signalée pour les fichiers de classe de ces répertoires. Par exemple : target/classes,target/testClasses.

répertoires de fichiers sources codeCoverageSourceDirectories -
Alias d’entrée : srcDirectories. string. Optionnel. Utilisez quand codeCoverageTool = JaCoCo.

Ce champ est requis pour un projet multimodèle.
Spécifie une liste séparée par des virgules des chemins d’accès relatifs du fichier POM Maven aux répertoires de code source. Les rapports de couverture du code utilisent ceux-ci pour mettre en évidence le code source. Par exemple : src/java,src/Test.

codeCoverageFailIfEmpty - Échouer lorsque les résultats de couverture du code sont manquants
Alias d’entrée : failIfCoverageEmpty. boolean. Optionnel. Utilisez quand codeCoverageTool != None. Valeur par défaut : false.

Échec de la génération si la couverture du code n’a pas produit de résultats à publier.

codeCoverageRestoreOriginalPomXml - Restaurer l'pom.xml d’origine après l’exécution de la tâche
Alias d’entrée : restoreOriginalPomXml. boolean. Optionnel. Utilisez quand codeCoverageTool != None. Valeur par défaut : false.

La couverture du code modifie pom.xml pour produire des résultats. Utilisez cette option si vous devez conserver la pom.xmld’origine.

javaHomeOption - définir JAVA_HOME par
Alias d’entrée : javaHomeSelection. string. Obligatoire. Valeurs autorisées : JDKVersion (version JDK), Path. Valeur par défaut : JDKVersion.

Définit JAVA_HOME en sélectionnant une version JDK qui sera découverte pendant les builds ou en entrant manuellement un chemin JDK. Si vous avez déjà installé Java sur l’ordinateur agent, vous pouvez le spécifier en configurant javaHomeOption en tant que path et jdkDirectory comme chemin d’accès au répertoire jDK installé.

jdkVersionOption - version JDK
Alias d’entrée : jdkVersion. string. Optionnel. Utilisez quand javaHomeSelection = JDKVersion. Valeurs autorisées : default, 1.21 (JDK 21), 1.17 (JDK 17), 1.11 (JDK 11), 1.10 (JDK 10 (hors support))), 1.9 (JDK 9 (hors support)), 1.8 (JDK 8), 1.7 (JDK 7), 1.6 (JDK 6 (hors support)). Valeur par défaut : default.

Tente de découvrir le chemin d’accès à la version de JDK sélectionnée et définit JAVA_HOME en conséquence.
Remarque : En cas d’exécution sur un agent qui n’est pas hébergé par Microsoft et que la version Java demandée n’est pas celle indiquée par la variable JAVA_HOME définie sur l’ordinateur de l’agent, la tâche s’appuie sur la variable JAVA_HOME_{version}_{arch} (par exemple : JAVA_HOME_8_X64) pour localiser le JDK nécessaire. Vérifiez que cette variable est définie sur les agents auto-hébergés pour toute version et architecture du JDK qui peut être demandée par ce paramètre et/ou par jdkArchitecture.

jdkDirectory - chemin JDK
Alias d’entrée : jdkUserInputPath. string. Obligatoire lorsque javaHomeSelection = Path.

Définit JAVA_HOME le chemin d’accès donné.

jdkArchitectureOption - architecture JDK
Alias d’entrée : jdkArchitecture. string. Optionnel. Utilisez quand jdkVersion != default. Valeurs autorisées : x86, x64. Valeur par défaut : x64.

Fournit l’architecture (x86, x64) du JDK.

mavenVersionOption - version de Maven
Alias d’entrée : mavenVersionSelection. string. Obligatoire. Valeurs autorisées : Default, Path (chemin personnalisé). Valeur par défaut : Default.

Spécifie la version Maven par défaut ou la version dans le chemin personnalisé spécifié.

mavenDirectory - chemin Maven
Alias d’entrée : mavenPath. string. Obligatoire lorsque mavenVersionSelection = Path.

Fournit le chemin d’accès personnalisé à l’installation Maven (par exemple : /usr/share/maven).

mavenSetM2Home - définir de variable M2_HOME
boolean. Optionnel. Utilisez quand mavenVersionSelection = Path. Valeur par défaut : false.

Définit la variable M2_HOME sur un chemin d’installation Maven personnalisé.

mavenOptions - définir MAVEN_OPTS sur
Alias d’entrée : mavenOpts. string. Valeur par défaut : -Xmx1024m.

Définit la variable d’environnement MAVEN_OPTS, utilisée pour envoyer des arguments de ligne de commande pour démarrer la machine virtuelle JVM. L’indicateur -Xmx spécifie la mémoire maximale disponible pour la machine virtuelle JVM.

mavenAuthenticateFeed - s’authentifier avec les flux Artefacts
Alias d’entrée : mavenFeedAuthenticate. boolean. Valeur par défaut : false.

S’authentifie automatiquement avec les flux Azure Artifacts. Si les flux Artifacts ne sont pas utilisés, désélectionnez cette option pour des builds plus rapides.

effectivePomSkip - Ignorer la génération de pom efficace lors de l’authentification avec les flux Artifacts
Alias d’entrée : skipEffectivePom. boolean. Valeur par défaut : false.

S’authentifie auprès des flux Artifacts à l’aide du POM uniquement.

sonarQubeRunAnalysis - exécuter l’analyse SonarQube ou SonarCloud
Alias d’entrée : sqAnalysisEnabled. boolean. Valeur par défaut : false.

Cette option a changé à l’aide de la version 1 de la tâche Maven à l’aide des extensions SonarQube et SonarCloud marketplace.
Activez cette option pour exécuter analyse SonarQube ou SonarCloud après avoir exécuté des objectifs dans le champ Objectifs. L''installer ou objectif de package doit s’exécuter en premier. Avant cette tâche Maven, vous devez également ajouter une tâche Préparer la configuration d’analyse de l’une des extensions au pipeline de build.

isJacocoCoverageReportXML - Utiliser des rapports Jacoco XML pour l’analyse SonarQube
boolean. Optionnel. Utilisez quand sqAnalysisEnabled = true && codeCoverageTool = JaCoCo. Valeur par défaut : false.

Utilise des rapports Jacoco XML pour l’analyse SonarQube. En savoir plus sur les rapports de test .

sqMavenPluginVersionChoice - scanneur SonarQube pour la version de Maven
string. Obligatoire lorsque sqAnalysisEnabled = true. Valeurs autorisées : latest (Utiliser la dernière version), pom (Utiliser la version déclarée dans votre pom.xml). Valeur par défaut : latest.

Spécifie la version du plug-in SonarQube Maven à utiliser. Vous pouvez utiliser la dernière version ou vous appuyer sur la version de votre pom.xml.

checkStyleRunAnalysis - Exécuter le checkstyle
Alias d’entrée : checkstyleAnalysisEnabled. boolean. Valeur par défaut : false.

Exécute l’outil Checkstyle avec les vérifications Sun par défaut. Si aucune configuration Checkstyle n’est spécifiée dans le fichier pom.xml, les vérifications Sun par défaut sont utilisées. Les résultats sont chargés en tant qu’artefacts de build.

pmdRunAnalysis - exécuter le PMD
Alias d’entrée : pmdAnalysisEnabled. boolean. Valeur par défaut : false.

Utilise l’outil d’analyse statique PMD pour rechercher des bogues dans le code. Les résultats sont chargés en tant qu’artefacts de build.

findBugsRunAnalysis - Exécuter findBugs
Alias d’entrée : findbugsAnalysisEnabled. boolean. Valeur par défaut : false.

Utilise l’outil d’analyse statique FindBugs pour rechercher des bogues dans le code. Les résultats sont chargés en tant qu’artefacts de build.

spotBugsRunAnalysis - Exécuter l’analyse SpotBugs
Alias d’entrée : spotBugsAnalysisEnabled. boolean. Valeur par défaut : false.

Activez cette option pour exécuter le plug-in d’analyse du code SpotBugs. Plus d’informations sur le plug-in SpotBugs Maven .

numéro de version spotBugsVersion -
Alias d’entrée : spotBugsMavenPluginVersion. string. Optionnel. Utilisez quand spotBugsAnalysisEnabled = true. Valeur par défaut : 4.5.3.0.

Découvrez les versions disponibles de SpotBugs.

spotBugsGoal - L’objectif du plug-in spotbugs
string. Optionnel. Utilisez quand spotBugsAnalysisEnabled = true. Valeurs autorisées : spotbugs (« spotbugs » - Crée un rapport sur les bogues détectés), check (« vérifier » - Le pipeline échoue si des bogues ont été détectés). Valeur par défaut : spotbugs.

Spécifie l’objectif du plug-in. En savoir plus sur objectifs SpotBugs.

failWhenBugsFound - Échouer lorsque des bogues sont trouvés avec spotbugs :check
Alias d’entrée : spotBugsFailWhenBugsFound | sbFailWhenBugsFound. boolean. Optionnel. Utilisez quand spotBugsAnalysisEnabled = true && spotBugsGoal = check. Valeur par défaut : true.

Échoue lorsque des bogues sont détectés si Vérifier l’objectif est spécifié. En savoir plus sur les détails du paramètre SpotBug .

Options de contrôle de la tâche

Toutes les tâches ont des options de contrôle en plus de leurs entrées de tâches. Pour plus d’informations, consultez Options de contrôle et propriétés de tâche courantes.

Variables de sortie

Aucun.

Remarques

La configuration de l’analyse SonarQube a été déplacée vers les extensions SonarQube ou SonarCloud dans la tâche Préparer la configuration d’analyse.

Important

Lorsque vous utilisez l’option -q dans votre MAVEN_OPTS, une pom efficace ne sera pas générée correctement et les flux Azure Artifacts peuvent ne pas être authentifiés.

Important

Si la version JDK que vous souhaitez utiliser est déjà installée sur votre agent, définissez javaHomeOption sur path et définissez l'jdkDirectory sur le chemin d’accès de la version JDK. Ces options définissent la variable d’environnement JAVA_HOME_11_X64, qui est requise par la tâche Maven. Cette variable d’environnement est définie automatiquement si vous utilisez la tâche du programme d’installation de l’outil Java.

Questions fréquentes (FAQ)

J’ai un projet multimodèle, mais ma build échoue. Que dois-je vérifier ?

Vérifiez que vous avez spécifié #codeCoverageClassFilesDirectories et #codeCoverageSourceDirectories comme entrée de tâche. Ces deux paramètres sont facultatifs pour un projet de module unique, mais sont requis pour les projets multimodèles.

Exemples

• générer et déployer votre application Java sur une application web Azure.

Spécifications

Besoin	Descriptif
Types de pipelines	YAML, Build Classique, Version Classique
Exécutions sur	Agent, DeploymentGroup
demandes	Les agents auto-hébergés doivent disposer de fonctionnalités qui correspondent aux exigences de suivantes pour exécuter des travaux qui utilisent cette tâche : maven
fonctionnalités de	Cette tâche ne répond à aucune demande de tâches ultérieures dans le travail.
restrictions de commande	N'importe quel
variables settables	N'importe quel
Version de l’agent	1.89.0 ou version ultérieure
Catégorie de tâche	Construire

Voir aussi

• Maven authentifie
• Publier des artefacts Maven avec Azure Pipelines
• du programme d’installation de l’outil Java
• Créer des applications Java