Maven@3 – Maven v3 feladat

Ezzel a feladattal hozhat létre, tesztelhet és helyezhet üzembe az Apache Mavennel.

A feladat ezen verziója elavult; Maven@4.

Szinopszis

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

Bemenetek

mavenPOMFile - Maven POM-fájl
string. Szükséges. Alapértelmezett érték: pom.xml.

Megadja az adattár gyökerétől a Maven POM-fájlig vezető relatív elérési utat. További információt A POM- bemutatása című témakörben talál.

goals - cél(ok)
string. Alapértelmezett érték: package.

(Nem kötelező) Állítsa package a kód fordításához és .war fájlba való becsomagolásához. Ha ezt az argumentumot üresen hagyja, a build sikertelen lesz. További információt Bevezetés a Maven buildéletciklusába.

options - Beállítások
string.

(Nem kötelező) Megadja a használni kívánt Maven parancssori beállításokat.

publishJUnitResults - Közzététel az Azure Pipelinesban
boolean. Alapértelmezett érték: true.

Megadja a Maven-build által az Azure Pipelinesban létrehozott JUnit-teszteredmények közzétételének lehetőségét. Minden Test Results Files megfelelő teszteredmény-fájl az Azure Pipelines tesztfuttatásaként lesz közzétéve.

testResultsFiles - teszteredmény-fájlok
string. publishJUnitResults = trueesetén kötelező. Alapértelmezett érték: **/surefire-reports/TEST-*.xml.

Megadja a közzéteendő teszteredmény-fájlok elérési útját és mintáját.
Helyettesítő karakterek is használhatók.
További információ fájlegyeztetési mintákról.
Például **/TEST-*.xml minden olyan XML-fájlhoz, amelynek a neve TEST-kezdődik. Ha nincs megadva gyökérútvonal, a fájlok az alapértelmezett munkakönyvtár alatt lesznek megfeleltetve, amelynek értéke a $(System.DefaultWorkingDirectory)változóban érhető el. A **/TEST-*.xml értéke például valójában egyező fájlokat eredményez a $(System.DefaultWorkingDirectory)/**/TEST-*.xml.

testRunTitle - tesztelési cím
string. Opcionális. Használja a publishJUnitResults = true.

Megadja a tesztfuttatás nevét.

allowBrokenSymlinks - Hibás szimbolikus hivatkozások engedélyezése
Bemeneti alias: allowBrokenSymbolicLinks. boolean. Opcionális. Használja a publishJUnitResults = true. Alapértelmezett érték: true.

Ha falseértékre van állítva, a build meghiúsul, ha a feladat a tesztek eredményeinek közzétételekor hibás szimbolikus hivatkozást talál.

codeCoverageToolOption - Kódlefedettségi eszköz
Bemeneti alias: codeCoverageTool. string. Engedélyezett értékek: None, Cobertura, JaCoCo. Alapértelmezett érték: None.

Megadja a kódlefedettségi eszközt. A kódlefedettség engedélyezése a Maven futtatásakor beszúrja a tiszta célt a Maven-célok listájába.

codeCoverageClassFilter - osztálybevonási/kizárási szűrők
Bemeneti alias: classFilter. string. Opcionális. Használja a codeCoverageTool != None.

Vesszővel tagolt szűrőlistát ad meg, amely az osztályokat belefoglalja vagy kizárja a kódlefedettség gyűjtéséből. Például: +:com.*,+:org.*,-:my.app*.*.

codeCoverageClassFilesDirectories - osztályfájlok könyvtárai
Bemeneti alias: classFilesDirectories. string. Opcionális. Használja a codeCoverageTool = JaCoCo.

Ez a mező többmodulos projekthez szükséges.
Vesszővel elválasztott listát ad meg a Maven POM-fájltól az osztályfájlokat és archív fájlokat tartalmazó könyvtárakig (JAR, WAR stb.). A kódlefedettség az ezekben a könyvtárakban lévő osztályfájlokra vonatkozik. Például: target/classes,target/testClasses.

codeCoverageSourceDirectories - forrásfájlok könyvtárai
Bemeneti alias: srcDirectories. string. Opcionális. Használja a codeCoverageTool = JaCoCo.

Ez a mező többmodulos projekthez szükséges.
Vesszővel elválasztott listát ad meg a Maven POM-fájl és a forráskódkönyvtárak relatív elérési útjairól. A kódlefedettségi jelentések ezeket használják a forráskód kiemeléséhez. Például: src/java,src/Test.

codeCoverageFailIfEmpty - Sikertelen, ha a kódlefedettségi eredmények hiányoznak
Bemeneti alias: failIfCoverageEmpty. boolean. Opcionális. Használja a codeCoverageTool != None. Alapértelmezett érték: false.

Sikertelen a buildelés, ha a kódlefedettség nem hozott eredményt a közzétételhez.

codeCoverageRestoreOriginalPomXml - Feladatvégrehajtás utáni eredeti pom.xml visszaállítása
Bemeneti alias: restoreOriginalPomXml. boolean. Opcionális. Használja a codeCoverageTool != None. Alapértelmezett érték: false.

A kódlefedettség módosítja a pom.xml az eredmények előállításához. Ezt a lehetőséget akkor használja, ha meg kell őriznie az eredeti pom.xml.

javaHomeOption - JAVA_HOME beállítása
Bemeneti alias: javaHomeSelection. string. Szükséges. Engedélyezett értékek: JDKVersion (JDK-verzió), Path. Alapértelmezett érték: JDKVersion.

Beállítja JAVA_HOME a buildek során felderítendő JDK-verzió kiválasztásával vagy egy JDK-elérési út manuális beírásával. Ha már telepítve van a Java az ügynökgépen, megadhatja azt úgy, hogy javaHomeOptionpath és jdkDirectory a telepített JDK-címtár elérési útjaként.

jdkVersionOption - JDK-verzió
Bemeneti alias: jdkVersion. string. Opcionális. Használja a javaHomeSelection = JDKVersion. Engedélyezett értékek: default, 1.21 (JDK 21), 1.17 (JDK 17), 1.11 (JDK 11), 1.10 (JDK 10 (támogatáson kívül) )), 1.9 (JDK 9 (támogatáson kívül)), 1.8 (JDK 8), 1.7 (JDK 7), 1.6 (JDK 6 (támogatáson kívül)). Alapértelmezett érték: default.

Megpróbálja felderíteni a kijelölt JDK-verzió elérési útját, és ennek megfelelően állítja be JAVA_HOME.
Megjegyzés: Ha olyan ügynökön fut, amelyet nem a Microsoft üzemeltet, és a kért Java-verziót nem az ügynökgépen beállított JAVA_HOME változó jelzi, a feladat a szükséges JDK megkereséséhez a JAVA_HOME_{version}_{arch} változóra (például JAVA_HOME_8_X64) támaszkodik. Győződjön meg arról, hogy ez a változó a JDK bármely olyan verziójához és architektúrájához saját üzemeltetésű ügynökökre van beállítva, amelyeket ez a paraméter és/vagy jdkArchitectureigényelhet.

JDK-elérési út jdkDirectory -
Bemeneti alias: jdkUserInputPath. string. javaHomeSelection = Pathesetén kötelező.

Beállítja a JAVA_HOME a megadott elérési útra.

jdkArchitectureOption - JDK-architektúra
Bemeneti alias: jdkArchitecture. string. Opcionális. Használja a jdkVersion != default. Engedélyezett értékek: x86, x64, arm64. Alapértelmezett érték: x64.

A JDK architektúráját (x86, x64) biztosítja.

mavenVersionOption - Maven-verzió
Bemeneti alias: mavenVersionSelection. string. Szükséges. Engedélyezett értékek: Default, Path (Egyéni elérési út). Alapértelmezett érték: Default.

Megadja az alapértelmezett Maven-verziót vagy a megadott egyéni elérési út verzióját.

mavenDirectory - Maven-útvonal
Bemeneti alias: mavenPath. string. mavenVersionSelection = Pathesetén kötelező.

Megadja a Maven-telepítés egyéni elérési útját (például: /usr/share/maven).

mavenSetM2Home - M2_HOME változó beállítása
boolean. Opcionális. Használja a mavenVersionSelection = Path. Alapértelmezett érték: false.

Beállítja a M2_HOME változót egy egyéni Maven telepítési útvonalra.

mavenOptions - MAVEN_OPTS beállítása
Bemeneti alias: mavenOpts. string. Alapértelmezett érték: -Xmx1024m.

Beállítja a MAVEN_OPTS környezeti változót, amely parancssori argumentumok küldésére szolgál a JVM elindításához. A -Xmx jelző megadja a JVM számára elérhető maximális memóriát.

mavenAuthenticateFeed - Hitelesítés artifacts-hírcsatornákkal
Bemeneti alias: mavenFeedAuthenticate. boolean. Alapértelmezett érték: false.

Automatikus hitelesítés az Azure Artifacts-hírcsatornákkal. Ha az Artifacts-hírcsatornák nincsenek használatban, törölje ezt a lehetőséget a gyorsabb buildelés érdekében.

effectivePomSkip - Kihagyja a hatékony POM generálását az Artifacts-hírcsatornákkal való hitelesítés során
Bemeneti alias: skipEffectivePom. boolean. Alapértelmezett érték: false.

Csak A POM használatával hitelesíti az Artifacts-hírcsatornákat.

sonarQubeRunAnalysis - SonarQube vagy SonarCloud elemzési
Bemeneti alias: sqAnalysisEnabled. boolean. Alapértelmezett érték: false.

Ez a beállítás a Maven feladat 1. verziójáról a SonarQube és SonarCloud marketplace-bővítmények használatára vált.
Engedélyezze ezt a lehetőséget SonarQube vagy SonarCloud elemzési futtatásához a célok Célok mezőben való végrehajtása után. Először a telepítési vagy csomag célnak kell futnia. A Maven-feladat előtt hozzá kell adnia egy Elemzési konfiguráció előkészítése feladatot is az egyik bővítményből a buildelési folyamathoz.

isJacocoCoverageReportXML - Xml Jacoco-jelentések használata SonarQube-elemzési
boolean. Opcionális. Használja a sqAnalysisEnabled = true && codeCoverageTool = JaCoCo. Alapértelmezett érték: false.

XML Jacoco-jelentéseket használ a SonarQube-elemzéshez. További információ tesztjelentésekről.

sqMavenPluginVersionChoice - SonarQube szkenner a Maven verzióhoz
string. sqAnalysisEnabled = trueesetén kötelező. Engedélyezett értékek: latest (Legújabb kiadás használata), pom (A pom.xmldeklarált verzió használata). Alapértelmezett érték: latest.

A Használni kívánt SonarQube Maven beépülő modulverziót adja meg. Használhatja a legújabb verziót, vagy támaszkodhat a pom.xml.

checkStyleRunAnalysis - Checkstyle futtatása
Bemeneti alias: checkstyleAnalysisEnabled. boolean. Alapértelmezett érték: false.

A Checkstyle eszközt az alapértelmezett Sun-ellenőrzésekkel futtatja. Ha nincs megadva a Checkstyle konfiguráció a pom.xml fájlban, a rendszer az alapértelmezett Sun-ellenőrzéseket használja. Az eredmények buildösszetevőkként lesznek feltöltve.

pmdRunAnalysis - PMD- futtatása
Bemeneti alias: pmdAnalysisEnabled. boolean. Alapértelmezett érték: false.

A PMD statikus elemzési eszközével megkeresi a kód hibáit. Az eredmények buildösszetevőkként lesznek feltöltve.

findBugsRunAnalysis - FindBugs- futtatása
Bemeneti alias: findbugsAnalysisEnabled. boolean. Alapértelmezett érték: false.

A FindBugs statikus elemző eszközzel megkeresi a kód hibáit. Az eredmények buildösszetevőkként lesznek feltöltve.

spotBugsRunAnalysis - SpotBugs-elemzési futtatása
Bemeneti alias: spotBugsAnalysisEnabled. boolean. Alapértelmezett érték: false.

Engedélyezze ezt a lehetőséget a SpotBugs kódelemzési beépülő modul futtatásához. További információ a SpotBugs Maven beépülő modulról.

spotBugsVersion - verziószám
Bemeneti alias: spotBugsMavenPluginVersion. string. Opcionális. Használja a spotBugsAnalysisEnabled = true. Alapértelmezett érték: 4.5.3.0.

További információ a SpotBugs elérhető verzióinak.

spotBugsGoal - A spotbugs beépülő modul célja
string. Opcionális. Használja a spotBugsAnalysisEnabled = true. Engedélyezett értékek: spotbugs ("spotbugs" – Jelentést hoz létre a talált hibákról), check ("ellenőrzés" – Hiba észlelése esetén a folyamat meghiúsul). Alapértelmezett érték: spotbugs.

Megadja a beépülő modul célját. További információ SpotBugs-célokról.

failWhenBugsFound - Hiba, ha hibakeresési hibák találhatók: ellenőrizze
Bemeneti alias: spotBugsFailWhenBugsFound | sbFailWhenBugsFound. boolean. Opcionális. Használja a spotBugsAnalysisEnabled = true && spotBugsGoal = check. Alapértelmezett érték: true.

Hiba akkor fordul elő, ha Ellenőrző cél meg van adva. További információ SpotBug paraméter részleteiről.

Feladatvezérlési lehetőségek

Minden feladathoz tartoznak vezérlési lehetőségek is a feladat bemenetei mellett. További információ: Vezérlők és gyakori feladattulajdonságok.

Kimeneti változók

Nincs.

Megjegyzések

A SonarQube-elemzés konfigurációja át lett helyezve a SonarQube vagy SonarCloud bővítményekre a feladatban Elemzési konfiguráció előkészítése.

Fontos

Ha a -qMAVEN_OPTS beállítását használja, a rendszer nem hozza létre megfelelően a tényleges pom-t, és előfordulhat, hogy az Azure Artifacts-hírcsatornák nem lesznek hitelesítve.

Fontos

Ha a használni kívánt JDK-verzió már telepítve van az ügynökén, állítsa javaHomeOptionpath, és állítsa a jdkDirectory a JDK-verzió elérési útjára. Ezek a beállítások a Maven-feladat által megkövetelt JAVA_HOME_11_X64 környezeti változót állítják be. Ez a környezeti változó automatikusan be van állítva, ha a Java-eszköz telepítőfeladatát használja.

GYIK

Többmodulos projektem van, de a buildelésem sikertelen. Mit kell ellenőriznem?

Győződjön meg arról, hogy #codeCoverageClassFilesDirectories és #codeCoverageSourceDirectories adott meg tevékenységbemenetként. Ez a két paraméter nem kötelező egyetlen modulprojekthez, de többmodulos projektekhez szükséges.

Példák

• Java-alkalmazás létrehozása és üzembe helyezése egy Azure Web App-.

Követelmények

Követelmény	Leírás
Folyamattípusok	YAML, klasszikus build, klasszikus kiadás
Futtatás bekapcsolva	Ügynök, DeploymentGroup
Követelmények	A saját üzemeltetésű ügynököknek olyan képességekkel kell rendelkezniük, amelyek megfelelnek az alábbi követelményeknek, a feladatot használó feladatok futtatásához: maven
képességek	Ez a tevékenység nem felel meg a feladat későbbi tevékenységeire vonatkozó követelményeknek.
parancskorlátozások	Bármely
Változók beállítása	Bármely
Ügynök verziója	1.89.0 vagy újabb
Tevékenységkategória	Épít

Lásd még

• Maven hitelesítése
• Maven artefaktumok közzététele Azure Pipelines segítségével
• Java eszköz telepítője
• Java-alkalmazások létrehozása