Maven@3 - Tugas Maven v3

Gunakan tugas ini untuk membangun, menguji, dan menyebarkan dengan Apache Maven.

Sintaks

# 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. Wajib diisi. Nilai default: pom.xml.

Menentukan jalur relatif dari akar repositori ke file POM Maven. Lihat Pengantar POM untuk informasi selengkapnya.

goals - Tujuan
string. Nilai default: package.

(Opsional) Atur ke package untuk mengkompilasi kode Anda dan mengemasnya ke dalam file .war. Jika Anda membiarkan argumen ini kosong, build akan gagal. Lihat Pengenalan siklus hidup build Maven untuk informasi selengkapnya.

options - Pilihan
string.

(Opsional) Menentukan opsi baris perintah Maven apa pun yang ingin Anda gunakan.

publishJUnitResults - Menerbitkan ke Azure Pipelines
boolean. Nilai default: true.

Menentukan opsi untuk menerbitkan hasil pengujian JUnit yang dihasilkan oleh build Maven ke Azure Pipelines. Setiap pencocokan Test Results Files file hasil pengujian akan diterbitkan sebagai uji coba di Azure Pipelines.

testResultsFiles - File hasil pengujian
string. Diperlukan saat publishJUnitResults = true. Nilai default: **/surefire-reports/TEST-*.xml.

Menentukan jalur dan pola file hasil pengujian untuk diterbitkan.
Wildcard dapat digunakan.
Informasi selengkapnya tentang pola pencocokan file.
Misalnya, **/TEST-*.xml untuk semua file XML yang namanya dimulai dengan TEST-. Jika tidak ada jalur akar yang ditentukan, file dicocokkan di bawah direktori kerja default, nilai yang tersedia dalam variabel $(System.DefaultWorkingDirectory). Misalnya, nilai **/TEST-*.xml akan benar-benar menghasilkan file yang cocok dari $(System.DefaultWorkingDirectory)/**/TEST-*.xml.

testRunTitle - Judul uji coba
string. Opsional. Gunakan saat publishJUnitResults = true.

Menentukan nama untuk eksekusi pengujian.

allowBrokenSymlinks - Perbolehkan tautan simbolis yang rusak
Alias input: allowBrokenSymbolicLinks. boolean. Pilihan. Gunakan saat publishJUnitResults = true. Nilai default: true.

Jika diatur ke false, gagal build saat tugas menemukan tautan simbolis yang rusak saat menerbitkan hasil pengujian.

codeCoverageToolOption - Alat cakupan kode
Alias input: codeCoverageTool. string. Nilai yang diizinkan: None, Cobertura, dan JaCoCo. Nilai default: None.

Menentukan alat cakupan kode. Mengaktifkan cakupan kode menyisipkan tujuan bersih ke dalam daftar tujuan Maven saat Maven berjalan.

codeCoverageClassFilter - Filter penyertaan/pengecualian kelas
Alias input: classFilter. string. Pilihan. Gunakan saat codeCoverageTool != None.

Menentukan daftar filter yang dipisahkan koma untuk menyertakan atau mengecualikan kelas dari pengumpulan cakupan kode. Contohnya:+:com.*,+:org.*,-:my.app*.*

codeCoverageClassFilesDirectories - Direktori file kelas
Alias input: classFilesDirectories. string. Pilihan. Gunakan saat codeCoverageTool = JaCoCo.

Bidang ini diperlukan untuk proyek multi-modul.
Menentukan daftar jalur relatif yang dipisahkan koma dari file POM Maven ke direktori yang berisi file kelas dan file arsip (JAR, WAR, dll.). Cakupan kode dilaporkan untuk file kelas di direktori ini. Contohnya:target/classes,target/testClasses

codeCoverageSourceDirectories - Direktori file sumber
Alias input: srcDirectories. string. Pilihan. Gunakan saat codeCoverageTool = JaCoCo.

Bidang ini diperlukan untuk proyek multi-modul.
Menentukan daftar jalur relatif yang dipisahkan koma dari file POM Maven ke direktori kode sumber. Laporan cakupan kode menggunakannya untuk menyoroti kode sumber. Contohnya:src/java,src/Test

codeCoverageFailIfEmpty - Gagal saat hasil cakupan kode hilang
Alias input: failIfCoverageEmpty. boolean. Pilihan. Gunakan saat codeCoverageTool != None. Nilai default: false.

Gagal membangun jika cakupan kode tidak menghasilkan hasil apa pun untuk dipublikasikan.

codeCoverageRestoreOriginalPomXml - Memulihkan pom.xml asli setelah eksekusi tugas
Alias input: restoreOriginalPomXml. boolean. Opsional. Gunakan saat codeCoverageTool != None. Nilai default: false.

Cakupan kode memodifikasi pom.xml untuk menghasilkan hasil. Gunakan opsi ini jika Anda perlu menyimpan yang asli pom.xml.

javaHomeOption - Atur JAVA_HOME menurut
Alias input: javaHomeSelection. string. Wajib diisi. Nilai yang diizinkan: JDKVersion (Versi JDK), Path. Nilai default: JDKVersion.

JAVA_HOME Mengatur baik dengan memilih versi JDK yang akan ditemukan selama build atau dengan memasukkan jalur JDK secara manual. Jika Anda sudah menginstal Java pada mesin agen, Anda dapat menentukannya dengan menyiapkan javaHomeOption sebagai path dan jdkDirectory sebagai jalur ke direktori terinstal JDK.

jdkVersionOption - Versi JDK
Alias input: jdkVersion. string. Pilihan. Gunakan saat javaHomeSelection = JDKVersion. Nilai yang diizinkan: default, 1.17 (JDK 17), 1.11 (JDK 11), 1.10 (JDK 10 (di luar dukungan)), 1.9 (JDK 9 (di luar dukungan)), 1.8 (JDK 8), 1.7 (JDK 7), 1.6 (JDK 6 (di luar dukungan)). Nilai default: default.

Mencoba menemukan jalur ke versi JDK yang dipilih dan mengatur JAVA_HOME yang sesuai.
Catatan: Jika berjalan pada agen yang tidak dihosting oleh Microsoft, dan versi Java yang diminta bukan yang ditunjukkan oleh JAVA_HOME variabel yang diatur pada mesin agen, tugas akan mengandalkan variabel JAVA_HOME_{version}_{arch} (misalnya: JAVA_HOME_8_X64) untuk menemukan JDK yang diperlukan. Pastikan variabel ini diatur pada agen yang dihost sendiri untuk versi dan arsitektur JDK apa pun yang mungkin diminta oleh parameter ini dan/atau oleh jdkArchitecture.

jdkDirectory - Jalur JDK
Alias input: jdkUserInputPath. string. Diperlukan saat javaHomeSelection = Path.

Mengatur JAVA_HOME ke jalur yang diberikan.

jdkArchitectureOption - Arsitektur JDK
Alias input: jdkArchitecture. string. Pilihan. Gunakan saat jdkVersion != default. Nilai yang diizinkan: x86, x64. Nilai default: x64.

Memasok arsitektur (x86, x64) dari JDK.

mavenVersionOption - Versi Maven
Alias input: mavenVersionSelection. string. Wajib diisi. Nilai yang diizinkan: Default, Path (Jalur Kustom). Nilai default: Default.

Menentukan versi Maven default atau versi di jalur kustom yang ditentukan.

mavenDirectory - Jalur Maven
Alias input: mavenPath. string. Diperlukan saat mavenVersionSelection = Path.

Memasok jalur kustom ke penginstalan Maven (misalnya: /usr/share/maven).

mavenSetM2Home - Mengatur variabel M2_HOME
boolean. Pilihan. Gunakan saat mavenVersionSelection = Path. Nilai default: false.

M2_HOME Mengatur variabel ke jalur penginstalan Maven kustom.

mavenOptions - Atur MAVEN_OPTS ke
Alias input: mavenOpts. string. Nilai default: -Xmx1024m.

MAVEN_OPTS Mengatur variabel lingkungan, yang digunakan untuk mengirim argumen baris perintah untuk memulai JVM. Bendera -Xmx menentukan memori maksimum yang tersedia untuk JVM.

mavenAuthenticateFeed - Mengautentikasi dengan umpan Artefak
Alias input: mavenFeedAuthenticate. boolean. Nilai default: false.

Mengautentikasi secara otomatis dengan umpan Azure Artifacts. Jika umpan Artefak tidak digunakan, batalkan pilihan opsi ini untuk build yang lebih cepat.

effectivePomSkip - Lewati pembuatan POM yang efektif saat mengautentikasi dengan umpan Artefak
Alias input: skipEffectivePom. boolean. Nilai default: false.

Mengautentikasi dengan umpan Artefak hanya menggunakan POM.

sonarQubeRunAnalysis - Menjalankan analisis SonarQube atau SonarCloud
Alias input: sqAnalysisEnabled. boolean. Nilai default: false.

Opsi ini telah berubah dari menggunakan tugas Maven versi 1 menjadi menggunakan ekstensi marketplace SonarQube dan SonarCloud .
Aktifkan opsi ini untuk menjalankan analisis SonarQube atau SonarCloud setelah mengeksekusi tujuan di bidang Tujuan . Tujuan penginstalan atau paket harus berjalan terlebih dahulu. Sebelum tugas Maven ini, Anda juga harus menambahkan tugas Siapkan Konfigurasi Analisis dari salah satu ekstensi ke alur build.

isJacocoCoverageReportXML - Menggunakan laporan XML Jacoco untuk analisis SonarQube
boolean. Pilihan. Gunakan saat sqAnalysisEnabled = true && codeCoverageTool = JaCoCo. Nilai default: false.

Menggunakan laporan XML Jacoco untuk analisis SonarQube. Pelajari selengkapnya tentang laporan pengujian.

sqMavenPluginVersionChoice - Pemindai SonarQube untuk versi Maven
string. Diperlukan saat sqAnalysisEnabled = true. Nilai yang diizinkan: latest (Gunakan rilis terbaru), pom (Gunakan versi yang dideklarasikan dalam pom.xml Anda). Nilai default: latest.

Menentukan versi plugin SonarQube Maven untuk digunakan. Anda dapat menggunakan versi terbaru atau mengandalkan versi di Anda pom.xml.

checkStyleRunAnalysis - Jalankan Checkstyle
Alias input: checkstyleAnalysisEnabled. boolean. Nilai default: false.

Menjalankan alat Checkstyle dengan pemeriksaan Matahari default. Jika tidak ada konfigurasi Checkstyle yang ditentukan dalam pom.xml file, pemeriksaan Matahari default akan digunakan. Hasil diunggah sebagai artefak build.

pmdRunAnalysis - Jalankan PMD
Alias input: pmdAnalysisEnabled. boolean. Nilai default: false.

Menggunakan alat analisis statis PMD untuk mencari bug dalam kode. Hasil diunggah sebagai artefak build.

findBugsRunAnalysis - Jalankan FindBugs
Alias input: findbugsAnalysisEnabled. boolean. Nilai default: false.

Menggunakan alat analisis statis FindBugs untuk mencari bug dalam kode. Hasil diunggah sebagai artefak build.

spotBugsRunAnalysis - Menjalankan analisis SpotBugs
Alias input: spotBugsAnalysisEnabled. boolean. Nilai default: false.

Aktifkan opsi ini untuk menjalankan plugin analisis kode SpotBugs. Informasi lebih lanjut tentang plugin SpotBugs Maven.

spotBugsVersion - Nomor versi
Alias input: spotBugsMavenPluginVersion. string. Pilihan. Gunakan saat spotBugsAnalysisEnabled = true. Nilai default: 4.5.3.0.

Pelajari tentang versi SpotBug yang tersedia.

spotBugsGoal - Tujuan untuk plugin spotbugs
string. Pilihan. Gunakan saat spotBugsAnalysisEnabled = true. Nilai yang diizinkan: spotbugs ("spotbugs" - Membuat laporan tentang bug yang ditemukan), check ("periksa" - Alur gagal jika bug terdeteksi). Nilai default: spotbugs.

Menentukan tujuan plugin. Pelajari selengkapnya tentang tujuan SpotBugs.

failWhenBugsFound - Gagal ketika bug ditemukan dengan spotbugs:check
Alias input: spotBugsFailWhenBugsFound | sbFailWhenBugsFound. boolean. Pilihan. Gunakan saat spotBugsAnalysisEnabled = true && spotBugsGoal = check. Nilai default: true.

Gagal ketika bug ditemukan jika Check Goal ditentukan. Pelajari selengkapnya tentang detail parameter SpotBug.

Opsi kontrol tugas

Semua tugas memiliki opsi kontrol selain input tugas mereka. Untuk informasi selengkapnya, lihat Opsi kontrol dan properti tugas umum.

Variabel output

Tidak ada.

Keterangan

Konfigurasi analisis SonarQube dipindahkan ke ekstensi SonarQube atau SonarCloud dalam tugas Siapkan Konfigurasi Analisis.

Penting

Saat menggunakan -q opsi di Anda MAVEN_OPTS, pom yang efektif tidak akan dihasilkan dengan benar, dan umpan Azure Artifacts mungkin tidak dapat diautentikasi.

Penting

Jika versi JDK yang ingin Anda gunakan sudah diinstal pada agen Anda, atur javaHomeOption ke path dan atur jdkDirectory ke jalur versi JDK. Opsi ini mengatur JAVA_HOME_11_X64 variabel lingkungan, yang diperlukan oleh tugas Maven. Variabel lingkungan ini diatur secara otomatis jika Anda menggunakan tugas alat penginstal Java Tool.

FAQ

Saya memiliki proyek multi-modul, tetapi build saya gagal. Apa yang harus saya periksa?

Pastikan Anda telah menentukan #codeCoverageClassFilesDirectories dan #codeCoverageSourceDirectories sebagai input tugas. Kedua parameter ini bersifat opsional untuk satu proyek modul tetapi diperlukan untuk proyek multi-modul.

Contoh

• Bangun dan Sebarkan aplikasi Java Anda ke Azure Web App.

Persyaratan

Persyaratan	Deskripsi
Jenis alur	YAML, Build klasik, Rilis klasik
Berjalan pada	Agen, DeploymentGroup
Permintaan	Agen yang dihost sendiri harus memiliki kemampuan yang sesuai dengan tuntutan berikut untuk menjalankan pekerjaan yang menggunakan tugas ini: maven
Kemampuan	Tugas ini tidak memenuhi tuntutan apa pun untuk tugas berikutnya dalam pekerjaan.
Pembatasan perintah	Apa pun
Variabel yang dapat diatur	Apa pun
Versi agen	1.89.0 atau lebih tinggi
Kategori tugas	Build

Lihat juga

• Maven mengautentikasi
• Menerbitkan artefak Maven dengan Azure Pipelines
• Alat Penginstal Java
• Membangun aplikasi Java