Maven@3 – Maven v3-uppgift

Använd den här uppgiften för att skapa, testa och distribuera med 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.

Indata

mavenPOMFile - Maven POM-fil
string. Krävs. Standardvärde: pom.xml.

Anger den relativa sökvägen från lagringsplatsens rot till Maven POM-filen. Mer information finns i Introduktion till POM .

goals - Mål
string. Standardvärde: package.

(Valfritt) Ange till package för att kompilera koden och paketera den i en .war-fil. Om du lämnar det här argumentet tomt misslyckas bygget. Mer information finns i Introduktion till Maven-bygglivscykeln .

options - Alternativ
string.

(Valfritt) Anger alla Maven-kommandoradsalternativ som du vill använda.

publishJUnitResults - Publicera till Azure Pipelines
boolean. Standardvärde: true.

Anger alternativet för att publicera JUnit-testresultaten som skapats av Maven-versionen till Azure Pipelines. Varje matchning Test Results Files av testresultatfilen publiceras som en testkörning i Azure Pipelines.

testResultsFiles - Testresultatfiler
string. Krävs när publishJUnitResults = true. Standardvärde: **/surefire-reports/TEST-*.xml.

Anger sökvägen och mönstret för testresultatfiler som ska publiceras.
Jokertecken kan användas.
Mer information om filmatchningsmönster.
Till exempel **/TEST-*.xml för alla XML-filer vars namn börjar med TEST-. Om ingen rotsökväg anges matchas filerna under standardarbetskatalogen, vars värde är tillgängligt i variabeln $(System.DefaultWorkingDirectory). Till exempel resulterar värdet för **/TEST-*.xml faktiskt i matchande filer från $(System.DefaultWorkingDirectory)/**/TEST-*.xml.

testRunTitle - Testkörningsrubrik
string. Valfritt. Använd när publishJUnitResults = true.

Anger ett namn för testkörningen.

allowBrokenSymlinks - Tillåt brutna symboliska länkar
Indataalias: allowBrokenSymbolicLinks. boolean. Valfritt. Använd när publishJUnitResults = true. Standardvärde: true.

Om det är inställt på falsemisslyckas bygget när aktiviteten hittar en bruten symbolisk länk när testresultatet publiceras.

codeCoverageToolOption - Kodtäckningsverktyg
Indataalias: codeCoverageTool. string. Tillåtna värden: None, Cobertura, JaCoCo. Standardvärde: None.

Anger kodtäckningsverktyget. När du aktiverar kodtäckning infogas det rena målet i Maven-mållistan när Maven körs.

codeCoverageClassFilter - Filter för klassinkludering/undantag
Indataalias: classFilter. string. Valfritt. Använd när codeCoverageTool != None.

Anger en kommaavgränsad lista över filter som ska inkludera eller exkludera klasser från att samla in kodtäckning. Till exempel +:com.*,+:org.*,-:my.app*.*.

codeCoverageClassFilesDirectories - Kataloger för klassfiler
Indataalias: classFilesDirectories. string. Valfritt. Använd när codeCoverageTool = JaCoCo.

Det här fältet krävs för ett projekt med flera moduler.
Anger en kommaavgränsad lista över relativa sökvägar från Maven POM-filen till kataloger som innehåller klassfiler och arkivfiler (JAR, WAR osv.). Kodtäckning rapporteras för klassfiler i dessa kataloger. Till exempel target/classes,target/testClasses.

codeCoverageSourceDirectories - Kataloger för källfiler
Indataalias: srcDirectories. string. Valfritt. Använd när codeCoverageTool = JaCoCo.

Det här fältet krävs för ett projekt med flera moduler.
Anger en kommaavgränsad lista över relativa sökvägar från Maven POM-filen till källkodskataloger. Kodtäckningsrapporter använder dessa för att markera källkod. Till exempel src/java,src/Test.

codeCoverageFailIfEmpty - Misslyckas när kodtäckningsresultat saknas
Indataalias: failIfCoverageEmpty. boolean. Valfritt. Använd när codeCoverageTool != None. Standardvärde: false.

Det går inte att skapa om kodtäckningen inte gav några resultat att publicera.

codeCoverageRestoreOriginalPomXml - Återställa ursprungliga pom.xml efter aktivitetskörning
Indataalias: restoreOriginalPomXml. boolean. Valfritt. Använd när codeCoverageTool != None. Standardvärde: false.

Kodtäckningen ändras pom.xml för att ge resultat. Använd det här alternativet om du behöver behålla den ursprungliga pom.xml.

javaHomeOption - Ange JAVA_HOME efter
Indataalias: javaHomeSelection. string. Krävs. Tillåtna värden: JDKVersion (JDK-version), Path. Standardvärde: JDKVersion.

Anger JAVA_HOME antingen genom att välja en JDK-version som ska identifieras under byggen eller genom att manuellt ange en JDK-sökväg. Om du redan har Java installerat på agentdatorn kan du ange det genom att konfigurera javaHomeOption som path och jdkDirectory som en sökväg till den installerade JDK-katalogen.

jdkVersionOption - JDK-version
Indataalias: jdkVersion. string. Valfritt. Använd när javaHomeSelection = JDKVersion. Tillåtna värden: default, 1.17 (JDK 17), 1.11 (JDK 11), 1.10 (JDK 10 (stöds inte)), 1.9 (JDK 9 (av support)), 1.8 (JDK 8), 1.7 (JDK 7), 1.6 (JDK 6 (support saknas)). Standardvärde: default.

Försöker identifiera sökvägen till den valda JDK-versionen och anger JAVA_HOME därefter.
Observera: Om du kör på en agent som inte finns på Microsoft och den begärda Java-versionen inte är den som anges av JAVA_HOME variabeln som angetts på agentdatorn, förlitar sig uppgiften på variabeln JAVA_HOME_{version}_{arch} (till exempel : JAVA_HOME_8_X64) för att hitta den nödvändiga JDK:t. Se till att den här variabeln är inställd på lokalt installerade agenter för alla versioner och arkitekturer för JDK:t som kan begäras av den här parametern och/eller av jdkArchitecture.

jdkDirectory - JDK-sökväg
Indataalias: jdkUserInputPath. string. Krävs när javaHomeSelection = Path.

Anger JAVA_HOME till den angivna sökvägen.

jdkArchitectureOption - JDK-arkitektur
Indataalias: jdkArchitecture. string. Valfritt. Använd när jdkVersion != default. Tillåtna värden: x86, x64. Standardvärde: x64.

Tillhandahåller JDK:s arkitektur (x86, x64).

mavenVersionOption - Maven-version
Indataalias: mavenVersionSelection. string. Krävs. Tillåtna värden: Default, Path (anpassad sökväg). Standardvärde: Default.

Anger antingen standardversionen av Maven eller versionen i den angivna anpassade sökvägen.

mavenDirectory - Maven-sökväg
Indataalias: mavenPath. string. Krävs när mavenVersionSelection = Path.

Tillhandahåller den anpassade sökvägen till Maven-installationen (till exempel: /usr/share/maven).

mavenSetM2Home - Ange M2_HOME variabel
boolean. Valfritt. Använd när mavenVersionSelection = Path. Standardvärde: false.

Anger variabeln M2_HOME till en anpassad Maven-installationssökväg.

mavenOptions - Ange MAVEN_OPTS till
Indataalias: mavenOpts. string. Standardvärde: -Xmx1024m.

MAVEN_OPTS Anger miljövariabeln, som används för att skicka kommandoradsargument för att starta JVM. Flaggan -Xmx anger det maximala tillgängliga minnet för JVM.

mavenAuthenticateFeed - Autentisera med artefaktfeeds
Indataalias: mavenFeedAuthenticate. boolean. Standardvärde: false.

Autentiseras automatiskt med Azure Artifacts-feeds. Om Artefaktflöden inte används avmarkerar du det här alternativet för snabbare versioner.

effectivePomSkip - Hoppa över att generera effektiv POM vid autentisering med Artefaktflöden
Indataalias: skipEffectivePom. boolean. Standardvärde: false.

Autentiserar med Artifacts-feeds med endast POM.

sonarQubeRunAnalysis - Köra SonarQube- eller SonarCloud-analys
Indataalias: sqAnalysisEnabled. boolean. Standardvärde: false.

Det här alternativet har ändrats från att använda version 1 av Maven-uppgiften till att använda Marketplace-tilläggen SonarQube och SonarCloud .
Aktivera det här alternativet för att köra SonarQube- eller SonarCloud-analys när du har kört mål i fältet Mål . Installations - eller paketmålet ska köras först. Innan den här Maven-aktiviteten måste du också lägga till en förbereda analyskonfigurationsuppgift från ett av tilläggen till bygg-pipelinen.

isJacocoCoverageReportXML - Använda XML Jacoco-rapporter för SonarQube-analys
boolean. Valfritt. Använd när sqAnalysisEnabled = true && codeCoverageTool = JaCoCo. Standardvärde: false.

Använder XML Jacoco-rapporter för SonarQube-analys. Läs mer om testrapporter.

sqMavenPluginVersionChoice - SonarQube-skanner för Maven-version
string. Krävs när sqAnalysisEnabled = true. Tillåtna värden: latest (Använd den senaste versionen) pom (Använd version deklarerad i din pom.xml). Standardvärde: latest.

Anger den SonarQube Maven-pluginversion som ska användas. Du kan använda den senaste versionen eller förlita dig på versionen i din pom.xml.

checkStyleRunAnalysis - Kör Checkstyle
Indataalias: checkstyleAnalysisEnabled. boolean. Standardvärde: false.

Kör Verktyget Checkstyle med standardkontroller från Solen. Om ingen Checkstyle-konfiguration har angetts i pom.xml filen används standardsönkontroller. Resultaten laddas upp som byggartefakter.

pmdRunAnalysis - Kör PMD
Indataalias: pmdAnalysisEnabled. boolean. Standardvärde: false.

Använder pmd-verktyget för statisk analys för att leta efter buggar i koden. Resultaten laddas upp som byggartefakter.

findBugsRunAnalysis - Köra FindBugs
Indataalias: findbugsAnalysisEnabled. boolean. Standardvärde: false.

Använder verktyget för statisk analys i FindBugs för att leta efter buggar i koden. Resultaten laddas upp som byggartefakter.

spotBugsRunAnalysis - Köra SpotBugs-analys
Indataalias: spotBugsAnalysisEnabled. boolean. Standardvärde: false.

Aktivera det här alternativet om du vill köra plugin-programmet SpotBugs-kodanalys. Mer information om Plugin-programmet SpotBugs Maven.

spotBugsVersion - Versionsnummer
Indataalias: spotBugsMavenPluginVersion. string. Valfritt. Använd när spotBugsAnalysisEnabled = true. Standardvärde: 4.5.3.0.

Läs mer om tillgängliga versioner av SpotBugs.

spotBugsGoal - Målet för plugin-programmet spotbugs
string. Valfritt. Använd när spotBugsAnalysisEnabled = true. Tillåtna värden: spotbugs ("spotbugs" – Skapar en rapport om hittade buggar), check ("check" – Pipeline misslyckas om buggar har identifierats). Standardvärde: spotbugs.

Anger målet för plugin-programmet. Läs mer om SpotBugs-mål.

failWhenBugsFound - Fel när buggar hittas med spotbugs:check
Indataalias: spotBugsFailWhenBugsFound | sbFailWhenBugsFound. boolean. Valfritt. Använd när spotBugsAnalysisEnabled = true && spotBugsGoal = check. Standardvärde: true.

Misslyckas när buggar hittas om Check Goal har angetts. Läs mer om spotbug-parameterinformation.

Kontrollalternativ för aktivitet

Alla aktiviteter har kontrollalternativ utöver sina aktivitetsindata. Mer information finns i Kontrollalternativ och vanliga uppgiftsegenskaper.

Utdatavariabler

Inga.

Kommentarer

Konfigurationen av SonarQube-analysen flyttades till SonarQube- eller SonarCloud-tilläggen i uppgiften Förbered analyskonfiguration.

Viktigt

När du använder -q alternativet i MAVEN_OPTSgenereras inte en effektiv pom korrekt och Azure Artifacts-feeds kanske inte kan autentiseras.

Viktigt

Om JDK-versionen som du vill använda redan är installerad på din agent anger du javaHomeOption till path och anger jdkDirectory sökvägen till JDK-versionen. De här alternativen anger JAVA_HOME_11_X64 miljövariabeln, som krävs av Maven-aktiviteten. Den här miljövariabeln anges automatiskt om du använder installationsprogrammet för Java Tool.

Vanliga frågor

Jag har ett projekt med flera moduler, men mitt bygge misslyckas. Vad ska jag kontrollera?

Kontrollera att du har angett #codeCoverageClassFilesDirectories och #codeCoverageSourceDirectories som uppgiftsindata. De här två parametrarna är valfria för ett enskilt modulprojekt, men de krävs för projekt med flera moduler.

Exempel

• Skapa och distribuera java-programmet till en Azure-webbapp.

Krav

Krav	Beskrivning
Pipelinetyper	YAML, klassisk version, klassisk version
Körs på	Agent, DeploymentGroup
Krav	Lokalt installerade agenter måste ha funktioner som matchar följande krav för att köra jobb som använder den här uppgiften: maven
Funktioner	Den här aktiviteten uppfyller inte några krav för efterföljande uppgifter i jobbet.
Kommandobegränsningar	Valfri
Inställningsbara variabler	Valfri
Agentversion	1.89.0 eller senare
Uppgiftskategori	Skapa

Se även

• Maven-autentisering
• Publicera Maven-artefakter med Azure Pipelines
• Installationsprogram för Java-verktyg
• Skapa Java-appar