DotNetCoreCLI@2 - Tugas .NET Core v2

Buat, uji, kemas, atau terbitkan aplikasi dotnet, atau jalankan perintah dotnet kustom.

Sintaks

# .NET Core v2
# Build, test, package, or publish a dotnet application, or run a custom dotnet command.
- task: DotNetCoreCLI@2
  inputs:
    command: 'build' # 'build' | 'push' | 'pack' | 'publish' | 'restore' | 'run' | 'test' | 'custom'. Required. Command. Default: build.
    #publishWebProjects: true # boolean. Optional. Use when command = publish. Publish web projects. Default: true.
    #projects: # string. Optional. Use when command = build || command = restore || command = run || command = test || command = custom || publishWebProjects = false. Path to project(s) or solution(s). 
    #custom: # string. Required when command = custom. Custom command. 
    #arguments: # string. Optional. Use when command = build || command = publish || command = run || command = test || command = custom. Arguments. 
    #restoreArguments: # string. Optional. Use when command = restore. Arguments. 
    #publishTestResults: true # boolean. Optional. Use when command = test. Publish test results and code coverage. Default: true.
    #testRunTitle: # string. Optional. Use when command = test. Test run title. 
    #zipAfterPublish: true # boolean. Optional. Use when command = publish. Zip published projects. Default: true.
    #modifyOutputPath: true # boolean. Optional. Use when command = publish. Add project's folder name to publish path. Default: true.
    #packagesToPush: '$(Build.ArtifactStagingDirectory)/*.nupkg' # string. Alias: searchPatternPush. Required when command = push. Path to NuGet package(s) to publish. Default: $(Build.ArtifactStagingDirectory)/*.nupkg.
    #nuGetFeedType: 'internal' # 'internal' | 'external'. Required when command = push. Target feed location. Default: internal.
    #publishVstsFeed: # string. Alias: feedPublish. Required when command = push && nuGetFeedType = internal. Target feed. 
    #publishFeedCredentials: # string. Alias: externalEndpoint. Required when command = push && nuGetFeedType = external. NuGet server. 
    #packagesToPack: '**/*.csproj' # string. Alias: searchPatternPack. Required when command = pack. Path to csproj or nuspec file(s) to pack. Default: **/*.csproj.
    #configuration: '$(BuildConfiguration)' # string. Alias: configurationToPack. Optional. Use when command = pack. Configuration to Package. Default: $(BuildConfiguration).
    #packDirectory: '$(Build.ArtifactStagingDirectory)' # string. Alias: outputDir. Optional. Use when command = pack. Package Folder. Default: $(Build.ArtifactStagingDirectory).
    #nobuild: false # boolean. Optional. Use when command = pack. Do not build. Default: false.
    #includesymbols: false # boolean. Optional. Use when command = pack. Include Symbols. Default: false.
    #includesource: false # boolean. Optional. Use when command = pack. Include Source. Default: false.
  # Feeds and authentication
    #feedsToUse: 'select' # 'select' | 'config'. Alias: selectOrConfig. Required when command = restore. Feeds to use. Default: select.
    #vstsFeed: # string. Alias: feedRestore. Optional. Use when selectOrConfig = select && command = restore. Use packages from this Azure Artifacts feed. 
    #includeNuGetOrg: true # boolean. Optional. Use when selectOrConfig = select && command = restore. Use packages from NuGet.org. Default: true.
    #nugetConfigPath: # string. Optional. Use when selectOrConfig = config && command = restore. Path to NuGet.config. 
    #externalFeedCredentials: # string. Alias: externalEndpoints. Optional. Use when selectOrConfig = config && command = restore. Credentials for feeds outside this organization/collection. 
  # Advanced
    #noCache: false # boolean. Optional. Use when command = restore. Disable local cache. Default: false.
    #restoreDirectory: # string. Alias: packagesDirectory. Optional. Use when command = restore. Destination directory. 
    #verbosityRestore: 'Detailed' # '-' | 'Quiet' | 'Minimal' | 'Normal' | 'Detailed' | 'Diagnostic'. Optional. Use when command = restore. Verbosity. Default: Detailed.
  # Advanced
    #publishPackageMetadata: true # boolean. Optional. Use when command = push && nuGetFeedType = internal && command = push. Publish pipeline metadata. Default: true.
  # Pack options
    #versioningScheme: 'off' # 'off' | 'byPrereleaseNumber' | 'byEnvVar' | 'byBuildNumber'. Required when command = pack. Automatic package versioning. Default: off.
    #versionEnvVar: # string. Required when versioningScheme = byEnvVar && command = pack. Environment variable. 
    #majorVersion: '1' # string. Alias: requestedMajorVersion. Required when versioningScheme = byPrereleaseNumber && command = pack. Major. Default: 1.
    #minorVersion: '0' # string. Alias: requestedMinorVersion. Required when versioningScheme = byPrereleaseNumber && command = pack. Minor. Default: 0.
    #patchVersion: '0' # string. Alias: requestedPatchVersion. Required when versioningScheme = byPrereleaseNumber && command = pack. Patch. Default: 0.
  # Advanced
    #buildProperties: # string. Optional. Use when command = pack. Additional build properties. 
    #verbosityPack: 'Detailed' # '-' | 'Quiet' | 'Minimal' | 'Normal' | 'Detailed' | 'Diagnostic'. Optional. Use when command = pack. Verbosity. Default: Detailed.
  # Advanced
    #workingDirectory: # string. Optional. Use when command != restore && command != push && command != pack && command != pack && command != push && command != restore. Working directory.

Input

command - Perintah
string. Wajib diisi. Nilai yang diizinkan: build, ( push nuget push), pack, , publish, restorerun, test, custom. Nilai default: build.

Perintah dotnet untuk dijalankan. Tentukan custom untuk menambahkan argumen atau gunakan perintah yang tidak tercantum di sini.

Penting

Tugas NuGet Authenticate adalah cara baru yang direkomendasikan untuk mengautentikasi dengan Artefak Azure dan repositori NuGet lainnya. Perintah restore dan push dari tugas .NET Core CLI ini tidak lagi mengambil fitur baru dan hanya bug penting yang ditangani. Lihat keterangan untuk detailnya.

publishWebProjects - Menerbitkan proyek web
boolean. Pilihan. Gunakan saat command = publish. Nilai default: true.

Jika input ini diatur ke true, projects nilai properti dilewati, dan tugas mencoba menemukan proyek web di repositori dan menjalankan perintah terbitkan pada mereka. Proyek web diidentifikasi dengan adanya web.config file atau wwwroot folder dalam direktori. Dengan tidak adanya web.config file atau wwwroot folder, proyek yang menggunakan SDK web, seperti Microsoft.NET.Sdk.Web, dipilih.

projects - Jalur ke proyek atau solusi
string. Pilihan. Gunakan saat command = build || command = restore || command = run || command = test || command = custom || publishWebProjects = false.

Jalur ke .csproj file atau .sln yang akan digunakan. Anda dapat menggunakan kartubebas (misalnya **/*.csproj untuk semua .csproj file di semua subfolder). Untuk informasi selengkapnya, lihat referensi pola pencocokan file.

Jalur ini relatif terhadap akar repositori terlepas dari pengaturannya workingDirectory .

custom - Perintah kustom
string. Diperlukan saat command = custom.

Perintah yang akan diteruskan ke dotnet.exe untuk eksekusi. Untuk daftar lengkap perintah yang tersedia, lihat dokumentasi CLI dotnet.

arguments - Argumen
string. Pilihan. Gunakan saat command = build || command = publish || command = run || command = test || command = custom.

Menentukan argumen untuk perintah terpilih. Misalnya, konfigurasi build, folder output, dan runtime. Argumen bergantung pada perintah yang dipilih.

Input ini saat ini hanya menerima argumen untuk build, , publishrun, test, dan custom. Jika Anda ingin menambahkan argumen untuk perintah yang tidak tercantum, gunakan custom.

restoreArguments - Argumen
string. Opsional. Gunakan saat command = restore.

Menulis argumen tambahan yang akan diteruskan ke restore perintah .

publishTestResults - Menerbitkan hasil pengujian dan cakupan kode
boolean. Pilihan. Gunakan saat command = test. Nilai default: true.

Mengaktifkan opsi ini akan menghasilkan test results file TRX di $(Agent.TempDirectory), dan hasilnya akan diterbitkan ke server.

Opsi ini menambahkan --logger trx --results-directory $(Agent.TempDirectory) ke argumen baris perintah.

Cakupan kode dapat dikumpulkan dengan menambahkan --collect "Code coverage" opsi ke argumen baris perintah.

testRunTitle - Judul uji coba
string. Pilihan. Gunakan saat command = test.

Menyediakan nama untuk eksekusi pengujian.

zipAfterPublish - Proyek Zip yang diterbitkan
boolean. Pilihan. Gunakan saat command = publish. Nilai default: true.

Jika input ini diatur ke true, folder yang dibuat oleh perintah terbitkan akan di-zip dan dihapus.

modifyOutputPath - Menambahkan nama folder proyek untuk menerbitkan jalur
boolean. Pilihan. Gunakan saat command = publish. Nilai default: true.

Jika input ini diatur ke true, folder yang dibuat oleh perintah terbitkan akan memiliki nama file proyek yang diawali dengan nama folder mereka ketika jalur output ditentukan secara eksplisit dalam argumen. Ini berguna jika Anda ingin menerbitkan beberapa proyek ke folder yang sama.

feedsToUse - Umpan yang akan digunakan
Alias input: selectOrConfig. string. Diperlukan saat command = restore. Nilai yang diizinkan: select (Umpan yang saya pilih di sini), config (Umpan di NuGet.config saya). Nilai default: select.

Anda dapat memilih umpan dari Azure Artifacts dan/atau NuGet.org di sini, atau Anda dapat menerapkan nuget.config file ke repositori kode sumber Anda dan mengatur jalurnya menggunakan nugetConfigPath input.

vstsFeed - Gunakan paket dari umpan Azure Artifacts ini
Alias input: feedRestore. string. Pilihan. Gunakan saat selectOrConfig = select && command = restore.

Menyertakan umpan yang dipilih dalam yang dihasilkan NuGet.config. Anda harus menginstal Manajemen Paket dan berlisensi untuk memilih umpan di sini. projectName/feedName digunakan untuk umpan cakupan proyek. Hanya FeedName digunakan untuk umpan yang dilingkup organisasi. Catatan: Ini tidak didukung untuk perintah pengujian.

includeNuGetOrg - Menggunakan paket dari NuGet.org
boolean. Pilihan. Gunakan saat selectOrConfig = select && command = restore. Nilai default: true.

Termasuk NuGet.org dalam yang dihasilkan NuGet.config.

nugetConfigPath - Jalur ke NuGet.config
string. Pilihan. Gunakan saat selectOrConfig = config && command = restore.

NuGet.config di repositori Anda yang menentukan umpan untuk memulihkan paket.

externalFeedCredentials - Kredensial untuk umpan di luar organisasi/koleksi ini
Alias input: externalEndpoints. string. Pilihan. Gunakan saat selectOrConfig = config && command = restore.

Kredensial yang digunakan untuk registri eksternal yang terletak di yang dipilih NuGet.config. Untuk umpan dalam organisasi/koleksi ini, biarkan input ini kosong; kredensial build digunakan secara otomatis.

noCache - Menonaktifkan cache lokal
boolean. Pilihan. Gunakan saat command = restore. Nilai default: false.

Mencegah NuGet menggunakan paket dari cache komputer lokal.

restoreDirectory - Direktori tujuan
Alias input: packagesDirectory. string. Pilihan. Gunakan saat command = restore.

Menentukan folder tempat paket diinstal. Jika tidak ada folder yang ditentukan, paket akan dipulihkan ke dalam cache paket NuGet default.

verbosityRestore - Verbositas
string. Pilihan. Gunakan saat command = restore. Nilai yang diizinkan: -, , QuietMinimal, Normal, Detailed, Diagnostic. Nilai default: Detailed.

Menentukan jumlah detail yang ditampilkan dalam output untuk restore perintah .

packagesToPush - Jalur ke paket NuGet untuk diterbitkan
Alias input: searchPatternPush. string. Diperlukan saat command = push. Nilai default: $(Build.ArtifactStagingDirectory)/*.nupkg.

Pola untuk mencocokkan atau jalur ke nupkg file yang akan diunggah. Beberapa pola dapat dipisahkan oleh titik koma, dan Anda dapat membuat pola negatif dengan mengawalinya dengan !. Contoh: **/*.nupkg;!**/*.Tests.nupkg.

nuGetFeedType - Lokasi umpan target
string. Diperlukan saat command = push. Nilai yang diizinkan: internal (Organisasi/koleksi ini), external (Server NuGet Eksternal (termasuk organisasi/koleksi lain)). Nilai default: internal.

Menentukan apakah umpan target bersifat internal atau eksternal.

publishVstsFeed - Umpan target
Alias input: feedPublish. string. Diperlukan saat command = push && nuGetFeedType = internal.

Menentukan umpan yang dihosting di organisasi ini. Anda harus menginstal Manajemen Paket dan berlisensi untuk memilih umpan di sini.

publishPackageMetadata - Menerbitkan metadata alur
boolean. Pilihan. Gunakan saat command = push && nuGetFeedType = internal && command = push. Nilai default: true.

Mengaitkan metadata alur build/rilis ini (jalankan #, informasi kode sumber) dengan paket.

publishFeedCredentials - Server NuGet
Alias input: externalEndpoint. string. Diperlukan saat command = push && nuGetFeedType = external.

Koneksi layanan NuGet yang berisi kredensial server NuGet eksternal.

packagesToPack - Jalur ke file csproj atau nuspec untuk dikemas
Alias input: searchPatternPack. string. Diperlukan saat command = pack. Nilai default: **/*.csproj.

Pola untuk .csproj mencari atau .nuspec file yang akan dikemas.

Anda dapat memisahkan beberapa pola dengan titik koma, dan Anda dapat membuat pola negatif dengan mengawalinya dengan !. Contoh: **/*.csproj;!**/*.Tests.csproj.

configuration - Konfigurasi ke Paket
Alias input: configurationToPack. string. Opsional. Gunakan saat command = pack. Nilai default: $(BuildConfiguration).

Saat menggunakan .csproj file, input ini menentukan konfigurasi ke paket.

packDirectory - Folder Paket
Alias input: outputDir. string. Pilihan. Gunakan saat command = pack. Nilai default: $(Build.ArtifactStagingDirectory).

Folder tempat paket akan dibuat. Jika folder ini kosong, paket akan dibuat bersama csproj file.

nobuild - Jangan membangun
boolean. Pilihan. Gunakan saat command = pack. Nilai default: false.

Menentukan bahwa tugas tidak akan membangun proyek sebelum pengemasan. Tugas ini sesuai dengan --no-build parameter build perintah.

includesymbols - Sertakan Simbol
boolean. Pilihan. Gunakan saat command = pack. Nilai default: false.

Membuat paket NuGet simbol. Tugas ini sesuai dengan --include-symbols parameter baris perintah.

includesource - Sertakan Sumber
boolean. Pilihan. Gunakan saat command = pack. Nilai default: false.

Menyertakan kode sumber dalam paket. Tugas ini sesuai dengan --include-source parameter baris perintah.

versioningScheme - Penerapan versi paket otomatis
string. Diperlukan saat command = pack. Nilai yang diizinkan: off, byPrereleaseNumber (Gunakan tanggal dan waktu), byEnvVar (Gunakan variabel lingkungan), byBuildNumber (Gunakan nomor build). Nilai default: off.

Tugas ini tidak dapat digunakan dengan proyek yang dirujuk yang disertakan. Jika Anda memilih Use the date and time, ini akan menghasilkan versi yang mematuhi SemVer yang diformat sebagai X.Y.Z-ci-datetime tempat Anda memilih X, , Ydan Z.

Jika Anda memilih Use an environment variable, Anda harus memilih variabel lingkungan dan memastikannya berisi nomor versi yang ingin Anda gunakan.

Jika Anda memilih Use the build number, ini akan menggunakan nomor build untuk membuat versi paket Anda. Catatan: Di bawah Options, atur format nomor build ke $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r).

versionEnvVar - Variabel lingkungan
string. Diperlukan saat versioningScheme = byEnvVar && command = pack.

Menentukan nama variabel tanpa $, , $envatau %.

majorVersion - Utama
Alias input: requestedMajorVersion. string. Diperlukan saat versioningScheme = byPrereleaseNumber && command = pack. Nilai default: 1.

Versi X dalam X.Y.Z.

minorVersion - Kecil
Alias input: requestedMinorVersion. string. Diperlukan saat versioningScheme = byPrereleaseNumber && command = pack. Nilai default: 0.

Versi Y dalam X.Y.Z.

patchVersion - Patch
Alias input: requestedPatchVersion. string. Diperlukan saat versioningScheme = byPrereleaseNumber && command = pack. Nilai default: 0.

Versi Z dalam X.Y.Z.

buildProperties - Properti build tambahan
string. Pilihan. Gunakan saat command = pack.

Menentukan daftar token = value pasangan, dipisahkan oleh titik koma, di mana setiap kemunculan $token$.nuspec dalam file akan diganti dengan nilai yang diberikan. Nilai dapat berupa string dalam tanda kutip.

verbosityPack - Verbositas
string. Opsional. Gunakan saat command = pack. Nilai yang diizinkan: -, , QuietMinimal, Normal, Detailed, Diagnostic. Nilai default: Detailed.

Menentukan jumlah detail yang ditampilkan dalam output untuk pack perintah .

workingDirectory - Direktori kerja
string. Pilihan. Gunakan saat command != restore && command != push && command != pack && command != pack && command != push && command != restore.

Direktori kerja saat ini tempat skrip dijalankan. Empty adalah akar repositori (build) atau artefak (rilis), yaitu $(System.DefaultWorkingDirectory).

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

Penting

Tugas NuGet Authenticate adalah cara baru yang direkomendasikan untuk mengautentikasi dengan Artefak Azure dan repositori NuGet lainnya. Perintah restore dan push dari tugas .NET Core CLI ini tidak lagi mengambil fitur baru dan hanya bug penting yang ditangani.

Mengapa langkah build, publish, atau test saya gagal memulihkan paket?

Sebagian besar dotnet perintah, termasuk build, publish, dan test menyertakan langkah implisit restore . Ini akan gagal terhadap umpan terautentikasi, bahkan jika Anda berhasil dotnet restore menjalankan di langkah sebelumnya, karena langkah sebelumnya akan membersihkan kredensial yang digunakannya.

Untuk memperbaiki masalah ini, tambahkan --no-restore bendera ke kotak Arguments teks.

Selain itu, test perintah tidak mengenali feedRestore argumen atau vstsFeed , dan umpan yang ditentukan dengan cara ini tidak akan disertakan dalam file yang dihasilkan NuGet.config ketika langkah implisit restore berjalan. Disarankan agar langkah eksplisit dotnet restore digunakan untuk memulihkan paket. restore Perintah menghormati feedRestore argumen dan vstsFeed .

Mengapa saya mendapatkan peringatan NU1507 dengan Pemetaan Sumber Paket meskipun ketika membangun di komputer saya tidak memiliki peringatan?

Berbagai perintah yang melakukan pemulihan NuGet atau mengakses umpan NuGet membangun file sementara NuGet.config khusus yang menambahkan autentikasi NuGet untuk umpan NuGet artefak azure. Cara ini dilakukan bertentangan dengan skema yang digunakan Pemetaan Sumber Paket untuk memetakan paket ke sumber dan merusak konfigurasi Package Source Mappin dalam NuGet.config file di repositori Anda. Untuk mengatasi konflik ini, Anda dapat menggunakan tugas NuGet Authenticate untuk mengautentikasi dan setelah itu perintah kustom untuk memanggil perintah dotnet yang diinginkan tanpa NuGet.config modifikasi.

# Authenticate Azure DevOps NuGet feed
- task: NuGetAuthenticate@1
  displayName: 'Authenticate Azure DevOps NuGet feed'

# Restore project
- task: DotNetCoreCLI@2
  inputs:
    command: 'custom'
    custom: 'restore'

# Build project
- task: DotNetCoreCLI@2
  inputs:
    command: 'custom'
    custom: 'build'
    arguments: '--no-restore'

Mengapa saya harus check-in NuGet.config?

Memeriksa NuGet.config kontrol sumber memastikan bahwa informasi utama yang diperlukan untuk membangun proyek Anda—lokasi paketnya—tersedia untuk setiap pengembang yang memeriksa kode Anda.

Namun, untuk situasi di mana tim pengembang bekerja pada berbagai proyek, dimungkinkan juga untuk menambahkan umpan Azure Artifacts ke global NuGet.config di setiap komputer pengembang. Dalam situasi ini, menggunakan Feeds I select here opsi dalam tugas NuGet mereplikasi konfigurasi ini.

Pemecahan Masalah

Proyek menggunakan Kerangka Kerja Entitas telah berhenti bekerja pada Agen yang Dihosting

.NET Core tidak memiliki bawaan Entity Framework (EF). Anda harus menginstal EF sebelum memulai eksekusi atau menambahkan global.json ke proyek dengan versi .NET Core SDK yang diperlukan. Ini akan memastikan bahwa SDK yang benar digunakan untuk membangun proyek EF. Jika versi yang diperlukan tidak ada di komputer, tambahkan UseDotNetV2 tugas ke alur Anda untuk menginstal versi yang diperlukan. Untuk informasi selengkapnya, lihat Mendapatkan runtime Entity Framework Core.

Contoh

• Contoh build
• Contoh push
• Contoh push
• Contoh paket
• Menerbitkan contoh
• Pulihkan contoh
• Contoh pengujian

Contoh build

Membangun proyek

# Build project
- task: DotNetCoreCLI@2
  inputs:
    command: 'build'

Membangun Beberapa Proyek

# Build multiple projects
- task: DotNetCoreCLI@2
  inputs:
    command: 'build'
    projects: |
      src/proj1/proj1.csproj 
      src/proj2/proj2.csproj 
      src/other/other.sln    # Pass a solution instead of a csproj.

Contoh push

Mendorong paket NuGet ke umpan internal

# Push non test NuGet packages from a build to internal organization Feed
- task: DotNetCoreCLI@2
  inputs:
    command: 'push'
    searchPatternPush: '$(Build.ArtifactStagingDirectory)/*.nupkg;!$(Build.ArtifactStagingDirectory)/*.Tests.nupkg'
    feedPublish: 'FabrikamFeed'

Dorong paket NuGet ke umpan eksternal

# Push all NuGet packages from a build to external Feed
- task: DotNetCoreCLI@2
  inputs:
    command: 'push'
    nugetFeedType: 'external'
    externalEndPoint: 'MyNuGetServiceConnection'

Contoh paket

Mengemas NuGetPackage ke direktori output tertentu

# Pack a NuGet package to a test directory
- task: DotNetCoreCLI@2
  inputs: 
    command: 'pack'
    outputDir: '$(Build.ArtifactStagingDirectory)/TestDir'

Mengemas Paket Simbol

# Pack a symbol package along with NuGet package
- task: DotNetCoreCLI@2
  inputs: 
    command: 'pack'
    includesymbols: true

Menerbitkan contoh

Menerbitkan proyek ke folder tertentu

# Publish projects to specified folder.
- task: DotNetCoreCLI@2
  displayName: 'dotnet publish'
  inputs:
    command: 'publish'
    publishWebProjects: false
    projects: '**/*.csproj'
    arguments: '-o $(Build.ArtifactStagingDirectory)/Output'
    zipAfterPublish: true
    modifyOutputPath: true

Pulihkan contoh

#Restore packages with the .NET Core CLI task
- task: DotNetCoreCLI@2
  displayName: 'dotnet restore'
  inputs:
    command: 'restore'
    feedsToUse: 'select'
    feedRestore: 'projectName/feedName'
    projects: '**/*.csproj'
    includeNuGetOrg: true

Contoh pengujian

Menjalankan pengujian di repositori Anda

# Run tests and auto publish test results.
- task: DotNetCoreCLI@2
  inputs:
    command: 'test'

Persyaratan

Persyaratan	Deskripsi
Jenis alur	YAML, Build klasik, Rilis klasik
Berjalan pada	Agen
Permintaan	Tidak ada
Kemampuan	Tugas ini tidak memenuhi tuntutan untuk tugas berikutnya dalam pekerjaan.
Pembatasan perintah	Apa pun
Variabel yang dapat diatur	Apa pun
Versi agen	2.144.0 atau lebih tinggi
Kategori tugas	Build