Maven@4 - Attività Maven v4

Compilare, testare e distribuire con Apache Maven.

Sintassi

# Maven v4
# Build, test, and deploy with Apache Maven.
- task: Maven@4
  inputs:
    #azureSubscription: # string. Alias: ConnectedServiceName. Azure Resource Manager connection. 
    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.

Ingressi

azureSubscription - di connessione di Azure Resource Manager
Alias di input: ConnectedServiceName. string.

Specificare una connessione al servizio Azure Resource Manager configurata con la federazione dell'identità del carico di lavoro da usare AzurePipelinesCredential nei test di integrazione. Per altre informazioni, vedere Usare AzurePipelinesCredential nei test di integrazione.

Nota

Questo input supporta solo le connessioni al servizio ARM configurate per l'uso della federazione delle identità del carico di lavoro.

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

goal
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 - Pubblica in Azure Pipelines
boolean. Valore predefinito: true.

Specifica l'opzione per pubblicare i risultati dei test JUnit generati dalla compilazione Maven in Azure Pipelines. Ogni file di risultati del test corrispondente Test Results Files 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 criteri 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. Opzionale. Usare quando publishJUnitResults = true.

Specifica un nome per l'esecuzione del test.

allowBrokenSymlinks - Consenti collegamenti simbolici interrotti
Alias di input: allowBrokenSymbolicLinks. boolean. Opzionale. 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 del risultato dei test.

codeCoverageToolOption - strumento 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. Opzionale. Usare quando codeCoverageTool != None.

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

codeCoverageClassFilesDirectories - directory dei file di classe
Alias di input: classFilesDirectories. string. Opzionale. 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. Opzionale. 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 - Fail when code coverage results are missing
Alias di input: failIfCoverageEmpty. boolean. Opzionale. Usare quando codeCoverageTool != None. Valore predefinito: false.

Non riesce la compilazione se il code coverage non ha prodotto alcun risultato da pubblicare.

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

Code coverage modifica pom.xml per produrre risultati. Usare questa opzione se è necessario mantenere il pom.xmloriginale.

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 agente, è possibile specificarlo configurando javaHomeOption come path e jdkDirectory come percorso alla directory installata di JDK.

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

Tenta di individuare il percorso della versione JDK selezionata e imposta JAVA_HOME di conseguenza.
Nota: Se è in esecuzione su un agente non ospitato da Microsoft e la versione Java richiesta non è quella indicata dalla variabile JAVA_HOME impostata nel computer agente, l'attività si baserà sulla variabile JAVA_HOME_{version}_{arch} (ad esempio: JAVA_HOME_8_X64) per individuare il JDK necessario. Assicurarsi che questa variabile sia impostata su 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. Opzionale. 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 predefinita di Maven 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. Opzionale. Usare quando mavenVersionSelection = Path. Valore predefinito: false.

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

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

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

mavenAuthenticateFeed - eseguire l'autenticazione con i feed artifacts
Alias di input: mavenFeedAuthenticate. boolean. Valore predefinito: false.

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

effectivePomSkip - Skip generating effective POM while authenticating with Artifacts feed
Alias di input: skipEffectivePom. boolean. Valore predefinito: false.

Esegue l'autenticazione con i feed Artifacts usando solo POM.

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

Questa opzione è cambiata rispetto all'uso della versione 1 dell'attività di Maven all'uso delle estensioni SonarQube e SonarCloud marketplace.
Abilitare questa opzione per eseguire 'analisi di SonarQube o SonarCloud dopo l'esecuzione degli obiettivi nel campo obiettivi . L'obiettivo dell'installazione o del pacchetto di deve essere eseguito per primo. Prima di questa attività Maven, è necessario aggiungere anche un'attività Prepare Analysis Configuration da una delle estensioni alla pipeline di compilazione.

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

Usa i report XML Dioco per l'analisi di 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 nel pom.xml.

checkStyleRunAnalysis - Esegui 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 file pom.xml, vengono utilizzati 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. Opzionale. Usare quando spotBugsAnalysisEnabled = true. Valore predefinito: 4.5.3.0.

Informazioni su le versioni disponibili di SpotBugs.

spotBugsGoal - L'obiettivo del plug-in spotbugs
string. Opzionale. Usare quando spotBugsAnalysisEnabled = true. Valori consentiti: spotbugs ("spotbugs" - Crea un report sui bug rilevati), 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 - Fail when bugs are found with spotbugs:check
Alias di input: spotBugsFailWhenBugsFound | sbFailWhenBugsFound. boolean. Opzionale. Usare quando spotBugsAnalysisEnabled = true && spotBugsGoal = check. Valore predefinito: true.

Ha esito negativo quando vengono rilevati bug se viene specificato Check Goal. Altre informazioni sui dettagli del parametro SpotBug .

Opzioni di controllo attività

Tutte le attività hanno opzioni di controllo oltre ai relativi input di 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 nell' SonarQube o estensioni SonarCloud nell'attività Preparare la configurazione dell'analisi.

Importante

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

Importante

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

Usare AzurePipelinesCredential nei test di integrazione

Le librerie di identità di Azure per .NET, C++, Go, Java, JavaScript e Python forniscono il supporto per la federazione dell'identità del carico di lavoro, in modo che il codice eseguito dalle attività AzureCLI@2 e AzurePowerShell@5 possa eseguire l'autenticazione con Microsoft Entra ID (ad esempio, per accedere ad Azure) usando la classe AzurePipelinesCredential.

Molti clienti usano librerie client di Azure SDK nei test di integrazione richiamati da altre attività. Le attività DotNetCoreCLI@2, Maven@4 e VSTest@3 possono accedere alle risorse di Azure usando la classe AzurePipelinesCredential.

È possibile impostare la proprietà connectedService su una connessione al servizio di Azure configurata con la federazione delle identità del carico di lavoro. Il AzurePipelinesCredential richiede SYSTEM_ACCESSTOKEN da impostare.

Nell'esempio seguente viene illustrato l'input connectedService nell'attività DotNetCoreCLI@2. VSTest@3 e Maven@4 l'utilizzo è simile.

- task: DotNetCoreCLI@2
  inputs:
    command: 'run'
    connectedService: <Azure service connection configured with workload identity federation>
  env:
    SYSTEM_ACCESSTOKEN: $(System.AccessToken)

Per altre informazioni su AzurePipelinesCredential, vedere questa Migliorare il comportamento di sicurezza nelle connessioni al servizio di Azure con AzurePipelinesCredential.

Domande frequenti

Si dispone di un progetto multimodulo, ma la compilazione non riesce. 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 multimodulo.

Esempi

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

Fabbisogno

Requisito	Descrizione
Tipi di pipeline	YAML, build classica, versione classica
Viene eseguito in	Agente, DeploymentGroup
richieste	Gli agenti self-hosted devono avere funzionalità che corrispondono alle seguenti richiedono di eseguire processi che usano questa attività:
funzionalità di	Questa attività non soddisfa alcuna richiesta di attività successive nel processo.
restrizioni dei comandi	Qualunque
variabili impostabili	Qualunque
Versione dell'agente	1.89.0 o versione successiva
Categoria attività	Costruire

Vedere anche

• Maven autenticare
• Pubblicare artefatti Maven con Azure Pipelines
• programma di installazione dello strumento Java
• Creare app Java