Maven@3 – Maven v3-Vorgang

Verwenden Sie diese Aufgabe, um Apache Maven zu erstellen, zu testen und bereitzustellen.

Diese Version der Aufgabe ist veraltet; verwenden Sie Maven@4.

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

Eingänge

mavenPOMFile - Maven POM Datei
string. Erforderlich. Standardwert: pom.xml.

Gibt den relativen Pfad vom Repositorystamm zur Maven POM-Datei an. Weitere Informationen finden Sie unter Einführung in die POM-.

goals - Ziel(n)
string. Standardwert: package.

(Optional) Legen Sie fest, dass package, um Den Code zu kompilieren und in eine WAR-Datei zu verpacken. Wenn Sie dieses Argument leer lassen, schlägt der Build fehl. Weitere Informationen finden Sie unter Einführung in den Maven-Buildlebenszyklus.

options - Optionen
string.

(Optional) Gibt alle Maven-Befehlszeilenoptionen an, die Sie verwenden möchten.

publishJUnitResults - In Azure-Pipelines veröffentlichen
boolean. Standardwert: true.

Gibt die Option zum Veröffentlichen der JUnit-Testergebnisse an, die vom Maven-Build in Azure-Pipelines erstellt wurden. Jede Testergebnissedatei, die Test Results Files abgleicht, wird als Testlauf in Azure Pipelines veröffentlicht.

testResultsFiles - Testergebnisse
string. Erforderlich, wenn publishJUnitResults = true. Standardwert: **/surefire-reports/TEST-*.xml.

Gibt den Pfad und das Muster der zu veröffentlichenden Testergebnisdateien an.
Platzhalter können verwendet werden.
Weitere Informationen zu Dateiabgleichsmustern.
Beispiel: **/TEST-*.xml für alle XML-Dateien, deren Name mit TEST-beginnt. Wenn kein Stammpfad angegeben ist, werden Dateien unter dem Standardarbeitsverzeichnis abgeglichen, dessen Wert in der Variablen $(System.DefaultWorkingDirectory)verfügbar ist. Beispielsweise führt ein Wert von **/TEST-*.xml tatsächlich zu übereinstimmenden Dateien aus $(System.DefaultWorkingDirectory)/**/TEST-*.xml.

testRunTitle - Titel der Testausführung
string. Wahlfrei. Wird verwendet, wenn publishJUnitResults = true.

Gibt einen Namen für die Testausführung an.

allowBrokenSymlinks - fehlerhafte symbolische Verknüpfungen zulassen
Eingabealias: allowBrokenSymbolicLinks. boolean. Wahlfrei. Wird verwendet, wenn publishJUnitResults = true. Standardwert: true.

Wenn dieser Wert auf falsefestgelegt ist, schlägt der Build fehl, wenn die Aufgabe beim Veröffentlichen des Tests ergebnisses einen fehlerhaften symbolischen Link findet.

codeCoverageToolOption - Codeabdeckungstool
Eingabealias: codeCoverageTool. string. Zulässige Werte: None, Cobertura, JaCoCo. Standardwert: None.

Gibt das Codeabdeckungstool an. Durch aktivieren der Codeabdeckung wird das saubere Ziel in die Maven-Zielliste eingefügt, wenn Maven ausgeführt wird.

codeCoverageClassFilter - Klasseneinschluss-/Ausschlussfilter
Eingabealias: classFilter. string. Wahlfrei. Wird verwendet, wenn codeCoverageTool != None.

Gibt eine durch Trennzeichen getrennte Liste von Filtern an, die Klassen von der Erfassung der Codeabdeckung einschließen oder ausschließen sollen. Beispiel: +:com.*,+:org.*,-:my.app*.*.

codeCoverageClassFilesDirectories - Klassendateien
Eingabealias: classFilesDirectories. string. Wahlfrei. Wird verwendet, wenn codeCoverageTool = JaCoCo.

Dieses Feld ist für ein Mehrmodulprojekt erforderlich.
Gibt eine durch Trennzeichen getrennte Liste relativer Pfade aus der Maven POM-Datei zu Verzeichnissen an, die Klassendateien und Archivdateien (JAR, WAR usw.) enthalten. Die Codeabdeckung wird für Klassendateien in diesen Verzeichnissen gemeldet. Beispiel: target/classes,target/testClasses.

codeCoverageSourceDirectories - Quelldateien
Eingabealias: srcDirectories. string. Wahlfrei. Wird verwendet, wenn codeCoverageTool = JaCoCo.

Dieses Feld ist für ein Mehrmodulprojekt erforderlich.
Gibt eine durch Trennzeichen getrennte Liste relativer Pfade aus der Maven POM-Datei zu Quellcodeverzeichnissen an. Codeabdeckungsberichte verwenden diese, um Quellcode hervorzuheben. Beispiel: src/java,src/Test.

codeCoverageFailIfEmpty - Fehlschlagen, wenn die Ergebnisse der Codeabdeckung
Eingabealias: failIfCoverageEmpty. boolean. Wahlfrei. Wird verwendet, wenn codeCoverageTool != None. Standardwert: false.

Schlägt den Build fehl, wenn die Codeabdeckung keine Ergebnisse zur Veröffentlichung erzeugt hat.

codeCoverageRestoreOriginalPomXml - originale pom.xml nach der Aufgabenausführung wiederherstellen
Eingabealias: restoreOriginalPomXml. boolean. Wahlfrei. Wird verwendet, wenn codeCoverageTool != None. Standardwert: false.

Die Codeabdeckung ändert pom.xml, um Ergebnisse zu erzielen. Verwenden Sie diese Option, wenn Sie das ursprüngliche pom.xmlbeibehalten müssen.

javaHomeOption - Festlegen JAVA_HOME nach
Eingabealias: javaHomeSelection. string. Erforderlich. Zulässige Werte: JDKVersion (JDK Version), Path. Standardwert: JDKVersion.

Legt JAVA_HOME fest, indem entweder eine JDK-Version ausgewählt wird, die während der Builds erkannt wird, oder indem Sie manuell einen JDK-Pfad eingeben. Wenn Sie Java bereits auf dem Agentcomputer installiert haben, können Sie es angeben, indem Sie javaHomeOption als path einrichten und als Pfad zum installierten JDK-Verzeichnis jdkDirectory.

jdkVersionOption - JDK-Version
Eingabealias: jdkVersion. string. Wahlfrei. Wird verwendet, wenn javaHomeSelection = JDKVersion. Zulässige Werte: default, 1.21 (JDK 21), 1.17 (JDK 17), 1.11 (JDK 11), 1.10 (JDK 10 ( nicht unterstützt) )), 1.9 (JDK 9 (nicht unterstützt)), 1.8 (JDK 8), 1.7 (JDK 7), 1.6 (JDK 6 (nicht unterstützt)). Standardwert: default.

Versucht, den Pfad zur ausgewählten JDK-Version zu ermitteln und legt JAVA_HOME entsprechend fest.
Hinweis: Wenn sie auf einem Agent ausgeführt wird, der nicht von Microsoft gehostet wird und die angeforderte Java-Version nicht der von der JAVA_HOME Variable auf dem Agentcomputer festgelegt ist, basiert die Aufgabe auf der Variablen JAVA_HOME_{version}_{arch} (z. B. JAVA_HOME_8_X64), um den erforderlichen JDK zu finden. Stellen Sie sicher, dass diese Variable für selbst gehostete Agents für jede Version und Architektur des JDK festgelegt ist, die von diesem Parameter und/oder von jdkArchitectureangefordert werden kann.

jdkDirectory - JDK-Pfad
Eingabealias: jdkUserInputPath. string. Erforderlich, wenn javaHomeSelection = Path.

Legt JAVA_HOME auf den angegebenen Pfad fest.

jdkArchitectureOption - JDK-Architektur
Eingabealias: jdkArchitecture. string. Wahlfrei. Wird verwendet, wenn jdkVersion != default. Zulässige Werte: x86, x64. Standardwert: x64.

Liefert die Architektur (x86, x64) des JDK.

mavenVersionOption - Maven-Version
Eingabealias: mavenVersionSelection. string. Erforderlich. Zulässige Werte: Default, Path (benutzerdefinierter Pfad). Standardwert: Default.

Gibt entweder die Maven-Standardversion oder die Version im angegebenen benutzerdefinierten Pfad an.

mavenDirectory - Maven-Pfad
Eingabealias: mavenPath. string. Erforderlich, wenn mavenVersionSelection = Path.

Stellt den benutzerdefinierten Pfad zur Maven-Installation bereit (z. B. /usr/share/maven).

mavenSetM2Home - Festlegen M2_HOME Variablen
boolean. Wahlfrei. Wird verwendet, wenn mavenVersionSelection = Path. Standardwert: false.

Legt die M2_HOME Variable auf einen benutzerdefinierten Maven-Installationspfad fest.

mavenOptions - Festlegen von MAVEN_OPTS auf
Eingabealias: mavenOpts. string. Standardwert: -Xmx1024m.

Legt die MAVEN_OPTS Umgebungsvariable fest, die zum Senden von Befehlszeilenargumenten zum Starten des JVM verwendet wird. Das flag -Xmx gibt den maximalen Arbeitsspeicher an, der dem JVM zur Verfügung steht.

mavenAuthenticateFeed - Authentifizieren mit Artefaktenfeeds
Eingabealias: mavenFeedAuthenticate. boolean. Standardwert: false.

Authentifiziert sich automatisch mit Azure Artifacts-Feeds. Wenn Artefaktefeeds nicht verwendet werden, deaktivieren Sie diese Option für schnellere Builds.

effectivePomSkip - Überspringen der Generierung effektiver POM-Elemente beim Authentifizieren mit Artefaktenfeeds
Eingabealias: skipEffectivePom. boolean. Standardwert: false.

Authentifiziert sich nur mit Artefaktenfeeds mithilfe des POM.

sonarQubeRunAnalysis - Ausführen der SonarQube- oder SonarCloud-Analyse
Eingabealias: sqAnalysisEnabled. boolean. Standardwert: false.

Diese Option hat sich von der Verwendung von Version 1 der Maven Aufgabe zur Verwendung der SonarQube und SonarCloud Marketplace-Erweiterungen geändert.
Aktivieren Sie diese Option, um SonarQube- oder SonarCloud-Analyse auszuführen, nach der Ausführung von Zielen im Feld Ziele Feld. Das Installieren oder Pakets Ziel sollte zuerst ausgeführt werden. Vor dieser Maven-Aufgabe müssen Sie auch eine Aufgabe "Analysekonfiguration vorbereiten" von einer der Erweiterungen zur Buildpipeline hinzufügen.

isJacocoCoverageReportXML - Verwenden von XML-Jacoco-Berichten für die SonarQube-Analyse
boolean. Wahlfrei. Wird verwendet, wenn sqAnalysisEnabled = true && codeCoverageTool = JaCoCo. Standardwert: false.

Verwendet XML-Jacoco-Berichte für die SonarQube-Analyse. Erfahren Sie mehr über Testberichte.

sqMavenPluginVersionChoice - SonarQube Scanner für Maven Version
string. Erforderlich, wenn sqAnalysisEnabled = true. Zulässige Werte: latest (neueste Version verwenden), pom (In Ihrem pom.xmldeklarierte Version verwenden). Standardwert: latest.

Gibt die zu verwendende Version des SonarQube Maven-Plug-Ins an. Sie können die neueste Version verwenden oder sich auf die Version in Ihrem pom.xmlverlassen.

checkStyleRunAnalysis - Checkstyle- ausführen
Eingabealias: checkstyleAnalysisEnabled. boolean. Standardwert: false.

Führt das Checkstyle-Tool mit den Standardmäßigen Sun-Prüfungen aus. Wenn in der pom.xml-Datei keine Checkstyle-Konfiguration angegeben ist, werden standardmäßige Sun-Prüfungen verwendet. Ergebnisse werden als Buildartefakte hochgeladen.

pmdRunAnalysis - PMD- ausführen
Eingabealias: pmdAnalysisEnabled. boolean. Standardwert: false.

Verwendet das STATISCHE PMD-Analysetool, um nach Fehlern im Code zu suchen. Ergebnisse werden als Buildartefakte hochgeladen.

findBugsRunAnalysis - Ausführen von FindBugs-
Eingabealias: findbugsAnalysisEnabled. boolean. Standardwert: false.

Verwendet das statische Analysetool FindBugs, um nach Fehlern im Code zu suchen. Ergebnisse werden als Buildartefakte hochgeladen.

spotBugsRunAnalysis - Ausführen von SpotBugs-Analysen
Eingabealias: spotBugsAnalysisEnabled. boolean. Standardwert: false.

Aktivieren Sie diese Option, um das SpotBugs-Codeanalyse-Plug-In auszuführen. Weitere Informationen zum SpotBugs Maven Plugin.

spotBugsVersion - Versionsnummer
Eingabealias: spotBugsMavenPluginVersion. string. Wahlfrei. Wird verwendet, wenn spotBugsAnalysisEnabled = true. Standardwert: 4.5.3.0.

Erfahren Sie mehr über der verfügbaren Versionen von SpotBugs.

spotBugsGoal - Das Ziel für das Spotbugs Plugin
string. Wahlfrei. Wird verwendet, wenn spotBugsAnalysisEnabled = true. Zulässige Werte: spotbugs ("Spotbugs" – Erstellt einen Bericht zu gefundenen Fehlern), check ("Check" – Pipeline schlägt fehl, wenn Fehler erkannt wurden). Standardwert: spotbugs.

Gibt das Ziel des Plug-Ins an. Erfahren Sie mehr über SpotBugs-Ziele.

failWhenBugsFound - Fehlschlagen, wenn Fehler mit Spotbugs gefunden werden:
Eingabealias: spotBugsFailWhenBugsFound | sbFailWhenBugsFound. boolean. Wahlfrei. Wird verwendet, wenn spotBugsAnalysisEnabled = true && spotBugsGoal = check. Standardwert: true.

Schlägt fehl, wenn Fehler gefunden werden, wenn Ziel- angegeben ist. Erfahren Sie mehr über SpotBug-Parameterdetails.

Aufgabensteuerungsoptionen

Alle Aufgaben verfügen zusätzlich zu ihren Aufgabeneingaben über Steuerungsoptionen. Weitere Informationen finden Sie unter Steuerelementoptionen und allgemeinen Aufgabeneigenschaften.

Ausgabevariablen

Keiner.

Bemerkungen

Die Konfiguration der SonarQube-Analyse wurde in die SonarQube oder SonarCloud Erweiterungen in der Aufgabe verschoben Vorbereiten der Analysekonfiguration.

Wichtig

Wenn Sie die Option -q in Ihrem MAVEN_OPTSverwenden, wird kein effektiver Pomm richtig generiert, und Azure Artifacts-Feeds können möglicherweise nicht authentifiziert werden.

Wichtig

Wenn die JDK-Version, die Sie verwenden möchten, bereits auf Ihrem Agent installiert ist, legen Sie javaHomeOption auf path fest, und legen Sie die jdkDirectory auf den Pfad der JDK-Version fest. Diese Optionen legen die JAVA_HOME_11_X64 Umgebungsvariable fest, die von der Maven-Aufgabe erforderlich ist. Diese Umgebungsvariable wird automatisch festgelegt, wenn Sie die Java Tool-Installationsprogrammaufgabe verwenden.

Häufig gestellte Fragen

Ich habe ein Multimodulprojekt, aber mein Build ist fehlgeschlagen. Was sollte ich überprüfen?

Stellen Sie sicher, dass Sie #codeCoverageClassFilesDirectories und #codeCoverageSourceDirectories als Vorgangseingabe angegeben haben. Diese beiden Parameter sind für ein einzelnes Modulprojekt optional, sind jedoch für Multimodulprojekte erforderlich.

Beispiele

• Erstellen und Bereitstellen Ihrer Java-Anwendung in einer Azure Web App-.

Anforderungen

Anforderung	BESCHREIBUNG
Pipelinetypen	YAML, Classic Build, Classic Release
Läuft auf	Agent, DeploymentGroup
Anforderungen	Self-hosted agents must have capabilities that match the following anforderungen to run jobs that use this task: maven
Funktionen	Dieser Vorgang erfüllt keine Anforderungen für nachfolgende Vorgänge im Auftrag.
Befehlseinschränkungen	Jegliche
Settable-Variablen	Jegliche
Agentversion	1.89.0 oder höher
Vorgangskategorie	Bauen

Siehe auch

• Maven authentifizieren
• Veröffentlichen von Maven-Artefakten mit Azure Pipelines
• Java Tool Installer-
• Erstellen von Java-Apps