Maven@3 - Attività Maven v3

Usare questa attività per compilare, testare e distribuire con Apache Maven.

Sintassi

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

Input

mavenPOMFile - File POM Maven
string. Obbligatorio. Valore predefinito: pom.xml.

Specifica il percorso relativo dalla radice del repository al file POM Maven. Per altre informazioni, vedere Introduzione a POM .

goals - Obiettivi
string. Valore predefinito: package.

(Facoltativo) Impostare su package per compilare il codice e crearne il pacchetto in un file con estensione war. Se si lascia vuoto questo argomento, la compilazione avrà esito negativo. Per altre informazioni, vedere Introduzione al ciclo di vita della compilazione Maven .

options - Opzioni
string.

(Facoltativo) Specifica le opzioni della riga di comando maven che si desidera utilizzare.

publishJUnitResults - Pubblicare in Azure Pipelines
boolean. Valore predefinito: true.

Specifica l'opzione per pubblicare i risultati del test JUnit prodotti dalla compilazione Maven in Azure Pipelines. Ogni file di Test Results Files risultati del test corrispondente verrà pubblicato come esecuzione di test in Azure Pipelines.

testResultsFiles - File dei risultati dei test
string. Obbligatorio quando publishJUnitResults = true. Valore predefinito: **/surefire-reports/TEST-*.xml.

Specifica il percorso e il modello dei file dei risultati del test da pubblicare.
È possibile usare caratteri jolly.
Altre informazioni sui modelli di corrispondenza dei file.
Ad esempio, **/TEST-*.xml per tutti i file XML il cui nome inizia con TEST-. Se non viene specificato alcun percorso radice, i file vengono confrontati sotto la directory di lavoro predefinita, il cui valore è disponibile nella variabile $(System.DefaultWorkingDirectory). Ad esempio, un valore di **/TEST-*.xml genererà effettivamente i file corrispondenti da $(System.DefaultWorkingDirectory)/**/TEST-*.xml.

testRunTitle - Titolo esecuzione test
string. Facoltativa. Usare quando publishJUnitResults = true.

Specifica un nome per l'esecuzione del test.

allowBrokenSymlinks - Consenti collegamenti simbolici interrotti
Alias di input: allowBrokenSymbolicLinks. boolean. Facoltativa. Usare quando publishJUnitResults = true. Valore predefinito: true.

Se impostato su false, la compilazione non riesce quando l'attività trova un collegamento simbolico interrotto durante la pubblicazione dei risultati dei test.

codeCoverageToolOption - Strumento di code coverage
Alias di input: codeCoverageTool. string. Valori consentiti: None, Cobertura, JaCoCo. Valore predefinito: None.

Specifica lo strumento di code coverage. L'abilitazione del code coverage inserisce l'obiettivo pulito nell'elenco degli obiettivi Maven durante l'esecuzione di Maven.

codeCoverageClassFilter - Filtri di inclusione/esclusione di classi
Alias di input: classFilter. string. Facoltativa. Usare quando codeCoverageTool != None.

Specifica un elenco delimitato da virgole di filtri da includere o escludere classi dalla raccolta di code coverage. Ad esempio, +:com.*,+:org.*,-:my.app*.*.

codeCoverageClassFilesDirectories - Directory dei file di classe
Alias di input: classFilesDirectories. string. Facoltativa. Usare quando codeCoverageTool = JaCoCo.

Questo campo è obbligatorio per un progetto multimodulo.
Specifica un elenco delimitato da virgole di percorsi relativi dal file POM Maven alle directory contenenti file di classe e file di archivio (JAR, WAR e così via). Il code coverage viene segnalato per i file di classe in queste directory. Ad esempio, target/classes,target/testClasses.

codeCoverageSourceDirectories - Directory dei file di origine
Alias di input: srcDirectories. string. Facoltativa. Usare quando codeCoverageTool = JaCoCo.

Questo campo è obbligatorio per un progetto multimodulo.
Specifica un elenco delimitato da virgole di percorsi relativi dal file POM Maven alle directory del codice sorgente. I report di code coverage usano questi elementi per evidenziare il codice sorgente. Ad esempio, src/java,src/Test.

codeCoverageFailIfEmpty - Esito negativo quando mancano i risultati del code coverage
Alias di input: failIfCoverageEmpty. boolean. Facoltativa. Usare quando codeCoverageTool != None. Valore predefinito: false.

Non riesce la compilazione se code coverage non ha prodotto risultati da pubblicare.

codeCoverageRestoreOriginalPomXml - Ripristinare il pom.xml originale dopo l'esecuzione dell'attività
Alias di input: restoreOriginalPomXml. boolean. Facoltativa. Usare quando codeCoverageTool != None. Valore predefinito: false.

Il code coverage modifica pom.xml per produrre risultati. Usare questa opzione se è necessario mantenere l'oggetto originale pom.xml.

javaHomeOption - Impostare JAVA_HOME per
Alias di input: javaHomeSelection. string. Obbligatorio. Valori consentiti: JDKVersion (versione JDK), Path. Valore predefinito: JDKVersion.

Imposta JAVA_HOME selezionando una versione JDK che verrà individuata durante le compilazioni o immettendo manualmente un percorso JDK. Se Java è già installato nel computer dell'agente, è possibile specificarlo configurandolo javaHomeOption come path e jdkDirectory come percorso della directory installata di JDK.

jdkVersionOption - Versione di JDK
Alias di input: jdkVersion. string. Facoltativa. Usare quando javaHomeSelection = JDKVersion. Valori consentiti: default, 1.17 (JDK 17), 1.11 (JDK 11), 1.10 (JDK 10 (non supportato)), 1.9 (JDK 9 (fuori supporto)), 1.8 (JDK 8), 1.7 (JDK 7), 1.6 (JDK 6 (non supportato)). Valore predefinito: default.

Tenta di individuare il percorso della versione JDK selezionata e imposta di JAVA_HOME conseguenza.
Nota: Se in esecuzione su un agente non ospitato da Microsoft e la versione Java richiesta non è quella indicata dalla JAVA_HOME variabile impostata nel computer agente, l'attività si basa sulla variabile JAVA_HOME_{version}_{arch} (ad esempio: JAVA_HOME_8_X64) per individuare il JDK necessario. Assicurarsi che questa variabile sia impostata sugli agenti self-hosted per qualsiasi versione e architettura del JDK che può essere richiesto da questo parametro e/o da jdkArchitecture.

jdkDirectory - Percorso JDK
Alias di input: jdkUserInputPath. string. Obbligatorio quando javaHomeSelection = Path.

Imposta JAVA_HOME sul percorso specificato.

jdkArchitectureOption - Architettura JDK
Alias di input: jdkArchitecture. string. Facoltativa. Usare quando jdkVersion != default. Valori consentiti: x86, x64. Valore predefinito: x64.

Fornisce l'architettura (x86, x64) di JDK.

mavenVersionOption - Versione di Maven
Alias di input: mavenVersionSelection. string. Obbligatorio. Valori consentiti: Default, Path (Percorso personalizzato). Valore predefinito: Default.

Specifica la versione maven predefinita o la versione nel percorso personalizzato specificato.

mavenDirectory - Percorso Maven
Alias di input: mavenPath. string. Obbligatorio quando mavenVersionSelection = Path.

Fornisce il percorso personalizzato all'installazione di Maven, ad esempio : /usr/share/maven.

mavenSetM2Home - Impostare M2_HOME variabile
boolean. Facoltativa. Usare quando mavenVersionSelection = Path. Valore predefinito: false.

Imposta la M2_HOME variabile su un percorso di installazione Maven personalizzato.

mavenOptions - Impostare MAVEN_OPTS su
Alias di input: mavenOpts. string. Valore predefinito: -Xmx1024m.

Imposta la MAVEN_OPTS variabile di ambiente usata per inviare argomenti della riga di comando per avviare la JVM. Il -Xmx flag specifica la memoria massima disponibile per la JVM.

mavenAuthenticateFeed - Eseguire l'autenticazione con feed di artefatti
Alias di input: mavenFeedAuthenticate. boolean. Valore predefinito: false.

Esegue automaticamente l'autenticazione con i feed di Elementi di Azure. Se i feed di artefatti non sono in uso, deselezionare questa opzione per le compilazioni più veloci.

effectivePomSkip - Ignorare la generazione di POM efficaci durante l'autenticazione con feed di artefatti
Alias di input: skipEffectivePom. boolean. Valore predefinito: false.

Esegue l'autenticazione con feed Di artefatti usando solo pom.

sonarQubeRunAnalysis - Eseguire l'analisi sonarQube o SonarCloud
Alias di input: sqAnalysisEnabled. boolean. Valore predefinito: false.

Questa opzione è stata modificata dall'uso della versione 1 dell'attività Maven all'uso delle estensioni sonarQube e SonarCloud marketplace.
Abilitare questa opzione per eseguire l'analisi SonarQube o SonarCloud dopo l'esecuzione di obiettivi nel campo Obiettivi . L'obiettivo dell'installazione o del pacchetto deve essere eseguito prima. Prima di questa attività Maven, è necessario aggiungere anche un'attività Preparazione configurazione analisi da una delle estensioni alla pipeline di compilazione.

isJacocoCoverageReportXML - Usare report XML Markupco per l'analisi di SonarQube
boolean. Facoltativa. Usare quando sqAnalysisEnabled = true && codeCoverageTool = JaCoCo. Valore predefinito: false.

Usa report XML Markupco per l'analisi sonarQube. Altre informazioni sui report di test.

sqMavenPluginVersionChoice - Scanner SonarQube per La versione di Maven
string. Obbligatorio quando sqAnalysisEnabled = true. Valori consentiti: latest (Usare la versione più recente), pom (Usare la versione dichiarata nel pom.xml). Valore predefinito: latest.

Specifica la versione del plug-in SonarQube Maven da usare. È possibile usare la versione più recente o basarsi sulla versione in pom.xml.

checkStyleRunAnalysis - Eseguire checkstyle
Alias di input: checkstyleAnalysisEnabled. boolean. Valore predefinito: false.

Esegue lo strumento Checkstyle con i controlli Sun predefiniti. Se non viene specificata alcuna configurazione Checkstyle nel pom.xml file, vengono usati i controlli Sun predefiniti. I risultati vengono caricati come artefatti di compilazione.

pmdRunAnalysis - Eseguire PMD
Alias di input: pmdAnalysisEnabled. boolean. Valore predefinito: false.

Usa lo strumento di analisi statica PMD per cercare bug nel codice. I risultati vengono caricati come artefatti di compilazione.

findBugsRunAnalysis - Eseguire FindBugs
Alias di input: findbugsAnalysisEnabled. boolean. Valore predefinito: false.

Usa lo strumento di analisi statica FindBugs per cercare bug nel codice. I risultati vengono caricati come artefatti di compilazione.

spotBugsRunAnalysis - Eseguire l'analisi spotBugs
Alias di input: spotBugsAnalysisEnabled. boolean. Valore predefinito: false.

Abilitare questa opzione per eseguire il plug-in di analisi del codice SpotBugs. Altre informazioni sul plug-in SpotBugs Maven.

spotBugsVersion - Numero di versione
Alias di input: spotBugsMavenPluginVersion. string. Facoltativa. Usare quando spotBugsAnalysisEnabled = true. Valore predefinito: 4.5.3.0.

Informazioni sulle versioni disponibili di SpotBugs.

spotBugsGoal - Obiettivo del plug-in spotbugs
string. Facoltativa. Usare quando spotBugsAnalysisEnabled = true. Valori consentiti: ("spotbugs" - spotbugs Crea un report sui bug trovati), check ("check" - Pipeline ha esito negativo se sono stati rilevati bug). Valore predefinito: spotbugs.

Specifica l'obiettivo del plug-in. Altre informazioni sugli obiettivi spotBugs.

failWhenBugsFound - Errore quando vengono trovati bug con spotbugs:check
Alias di input: spotBugsFailWhenBugsFound | sbFailWhenBugsFound. boolean. Facoltativa. Usare quando spotBugsAnalysisEnabled = true && spotBugsGoal = check. Valore predefinito: true.

Non riesce quando vengono trovati bug se viene specificato Check Goal . Altre informazioni sui dettagli del parametro SpotBug.

Opzioni di controllo delle attività

Tutte le attività dispongono di opzioni di controllo oltre ai relativi input attività. Per altre informazioni, vedere Opzioni di controllo e proprietà comuni delle attività.

Variabili di output

Nessuno.

Osservazioni

La configurazione dell'analisi SonarQube è stata spostata nelle estensioni SonarQube o SonarCloud nell'attività Preparazione analisi configurazione.

Importante

Quando si usa l'opzione -q in MAVEN_OPTS, un pom efficace non verrà generato correttamente e i feed di Elementi di Azure potrebbero non essere in grado di essere autenticati.

Importante

Se la versione JDK da usare è già installata nell'agente, impostare javaHomeOption su path e impostare sul jdkDirectory percorso della versione JDK. Queste opzioni impostano la JAVA_HOME_11_X64 variabile di ambiente, richiesta dall'attività Maven. Questa variabile di ambiente viene impostata automaticamente se si usa l'attività del programma di installazione di Java Tool.

Domande frequenti

Si dispone di un progetto multi-modulo, ma la compilazione ha esito negativo. Cosa devo controllare?

Assicurarsi di aver specificato #codeCoverageClassFilesDirectories e #codeCoverageSourceDirectories come input dell'attività. Questi due parametri sono facoltativi per un singolo progetto di modulo, ma sono necessari per i progetti multi-modulo.

Esempio

• Compilare e distribuire l'applicazione Java in un'app Web di Azure.

Requisiti

Requisito	Descrizione
Tipi di pipeline	YAML, build classica, versione classica
Esecuzione in	Agente, DeploymentGroup
Richieste	Gli agenti self-hosted devono avere funzionalità che corrispondono alle richieste seguenti per eseguire processi che usano questa attività: maven
Capabilities	Questa attività non soddisfa le richieste per le attività successive nel processo.
Restrizioni dei comandi	Qualsiasi
Variabili impostabili	Qualsiasi
Versione agente	1.89.0 o versione successiva
Categoria attività	Compilazione

Vedi anche

• Autenticazione maven
• Pubblicare elementi Maven con Azure Pipelines
• Programma di installazione degli strumenti Java
• Compilare app Java