DotNetCoreCLI@2 - technologie .NET úkol Core v2

Sestavte, otestujte, zabalte nebo publikujte technologie .NET aplikaci, nebo spusťte vlastní příkaz technologie .NET CLI.

Syntaxe

# .NET Core v2
# Build, test, package, or publish a .NET application, or run a custom .NET CLI command.
- task: DotNetCoreCLI@2
  inputs:
    #azureSubscription: # string. Alias: ConnectedServiceName. Azure Resource Manager connection. 
    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.
    #requestTimeout: '300000' # string. Set timeout for package download request. Default: 300000.
  # 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. Select from the dropdown or enter [project name/]feed name. 
    #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: 'Normal' # '-' | 'Quiet' | 'Minimal' | 'Normal' | 'Detailed' | 'Diagnostic'. Optional. Use when command = restore. Verbosity. Default: Normal.
  # Advanced
    #publishPackageMetadata: true # boolean. Optional. Use when command = push && nuGetFeedType = internal. Publish pipeline metadata. Default: true.
  # Pack options
    #versioningScheme: 'off' # 'off' | 'byPrereleaseNumber' | 'byEnvVar' | 'byBuildNumber' | 'bySemVerBuildNumber'. 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: 'Normal' # '-' | 'Quiet' | 'Minimal' | 'Normal' | 'Detailed' | 'Diagnostic'. Optional. Use when command = pack. Verbosity. Default: Normal.
  # Advanced
    #workingDirectory: # string. Optional. Use when command != restore && command != push && command != pack. Working directory.

Vstupy

azureSubscription - Azure Resource Manager spojení
Vstupní alias: . .

Specifikujte Azure Resource Manager připojení ke službě nakonfigurované s federací identity zátěže pro použití AzurePipelinesCredential v integračních testech. Další informace najdete v tématu Použití AzurePipelinesCredential v integračních testech.

Poznámka

Tento vstup podporuje pouze připojení služby ARM nakonfigurovaná tak, aby používala federaci identit úloh.

command
. Požadovaný. Povolené hodnoty: , (nuget push), , , , , , . Výchozí hodnota: .

Příkaz dotnet, který se má spustit. Zadejte pro přidání argumentů nebo použití příkazu, který tu není uvedený.

Důležitý

Úkol NuGet Authenticate je novým doporučeným způsobem autentizace pomocí Azure Artifacts a dalších NuGet repozitářů. Příkazy restore a push této technologie .NET Core CLI úlohy již nepřijímají nové funkce a řeší se pouze kritické chyby. Podrobnosti najdete v poznámkách.

Publikování webových projektů
. Volitelný. Používá se při . Výchozí hodnota: .

Pokud je tento vstup nastavený na , hodnota vlastnosti se přeskočí a úloha se pokusí najít webové projekty v úložišti a spustit na nich příkaz publikovat. Webové projekty jsou identifikovány přítomností souboru nebo složky v adresáři. V nepřítomnosti souboru web.config nebo složky wwwroot jsou vybírány projekty, které používají webové SDK, například Microsofttechnologie .NET.Sdk.Web.

cesta k projektům nebo řešením
. Volitelný. Používá se při .

Cesta k nebo souborů, které se mají použít. Můžete použít zástupné cardy (například pro všechny soubory ve všech podsložkách). Další informace naleznete v vzory porovnávání souborů odkaz.

Tato cesta je relativní ke kořenovému adresáři úložiště bez ohledu na nastavení .

vlastního příkazu
. Požadováno při .

Příkaz, který se má předat ke spuštění. Úplný seznam dostupných příkazů najdete v dokumentaci k rozhraní příkazového řádku dotnet.

argumentů
. Volitelný. Používá se při .

Určuje argumenty pro vybraný příkaz. Například konfigurace sestavení, výstupní složka a modul runtime. Argumenty závisí na vybraném příkazu.

Tento vstup aktuálně přijímá pouze argumenty pro , , , a . Pokud chcete přidat argumenty pro příkaz, který není uvedený, použijte .

argumentů
. Volitelný. Používá se při .

Zapíše další argumenty, které se mají předat příkazu.

publikování výsledků testů a pokrytí kódu
. Volitelný. Používá se při . Výchozí hodnota: .

Povolením této možnosti se vygeneruje soubor TRX v a výsledky se publikují na server.

Pro VSTest se tato možnost přidává k argumentům příkazového řádku. Pro Microsoft.Testing.Platform, když je tato možnost detekována jako testovací runner v , se tato možnost přidává k argumentům příkazového řádku.

Pokrytí kódu lze získat přidáním volby (pro VSTest) nebo (pro Microsoft.Testing.Platform) do argumentů příkazové řádky.

název testovacího spuštění
. Volitelný. Používá se při .

Poskytuje název testovacího spuštění.

publikovaných projektů zip
. Volitelný. Používá se při . Výchozí hodnota: .

Pokud je tento vstup nastavený na , složky vytvořené příkazem publikování se zazipují a odstraní.

přidání názvu složky projektu pro publikování cesty
. Volitelný. Používá se při . Výchozí hodnota: .

Pokud je tento vstup nastavený na , složky vytvořené příkazem publish budou mít název souboru projektu s předponou jejich názvů složek, pokud je výstupní cesta zadána explicitně v argumentech. To je užitečné, pokud chcete publikovat více projektů do stejné složky.

informační kanály pro použití
Vstupní alias: . . Požadováno při . Povolené hodnoty: (informační kanály, které zde vyberu), (informační kanály v mém NuGet.config). Výchozí hodnota: .

Můžete si zde vybrat kanál z Azure Artifacts a/nebo NuGet.org, nebo můžete uložit soubor nuget.config do svého repozitáře zdrojového kódu a nastavit jeho cestu pomocí vstupu nugetConfigPath.

vstsFeed - Použijte balíčky z tohoto Azure Artifacts kanálu. Vyberte z rozbalovacího menu nebo zadejte [název projektu/]název kanálu.
Vstupní alias: . . Volitelný. Používá se při .

Zahrne vybraný informační kanál do vygenerovaného . Abyste mohli vybrat informační kanál, musíte mít nainstalovanou a licencovanou správu balíčků. se používají pro informační kanály v rozsahu projektu. Pro informační kanály v oboru organizace se používají jenom . Poznámka: Tento příkaz není podporován pro příkaz .

Používat balíčky z NuGet.org
. Volitelný. Používá se při . Výchozí hodnota: .

Zahrne do vygenerovaného .

cesta k NuGet.config
. Volitelný. Používá se při .

ve vašem úložišti, které určuje informační kanály, ze kterých se mají balíčky obnovit.

přihlašovací údaje pro informační kanály mimo tuto organizaci nebo kolekci
Vstupní alias: . . Volitelný. Používá se při .

Název připojení služby, které se má použít pro externí registry uvedené ve vybraném seznamu . U informačních kanálů ve stejné organizaci nebo kolekci ponechte tento vstup prázdný; přihlašovací údaje sestavení se používají automaticky.

Zakázat místní mezipaměti
. Volitelný. Používá se při . Výchozí hodnota: .

Zabrání NuGetu používat balíčky z mezipamětí místního počítače.

cílového adresáře
Vstupní alias: . . Volitelný. Používá se při .

Určuje složku, ve které jsou balíčky nainstalovány. Pokud není zadána žádná složka, balíčky se obnoví do výchozí mezipaměti balíčků NuGet.

podrobností
. Volitelný. Používá se při . Povolené hodnoty: , , , , , . Výchozí hodnota: .

Určuje množství podrobností zobrazených ve výstupu příkazu .

cesta k balíčkům NuGet k publikování
Vstupní alias: . . Požadováno při . Výchozí hodnota: .

Vzor, který se má shodovat, nebo cestu k souborům, které se mají nahrát. Více vzorů může být odděleno středníkem a můžete vytvořit vzor negativní předponou . Příklad: .

umístění cílového informačního kanálu
. Požadováno při . Povolené hodnoty: (tato organizace/kolekce), (externí server NuGet (včetně jiných organizací/kolekcí)). Výchozí hodnota: .

Určuje, jestli je cílový informační kanál interní nebo externí.

cílového informačního kanálu
Vstupní alias: . . Požadováno při .

Určuje informační kanál hostovaný v této organizaci. Abyste mohli vybrat informační kanál, musíte mít nainstalovanou a licencovanou správu balíčků.

publikování metadat kanálu
. Volitelný. Používá se při . Výchozí hodnota: .

Přidruží metadata kanálu buildu nebo verze (spustit #, informace o zdrojovém kódu) k balíčku.

serveru NuGet
Vstupní alias: . . Požadováno při .

Připojení služby NuGet obsahující přihlašovací údaje externího serveru NuGet.

Cesta k souborům csproj nebo nuspec pro zabalení
Vstupní alias: . . Požadováno při . Výchozí hodnota: .

Vzor pro vyhledání nebo souborů, které se mají zabalit.

Více vzorů můžete oddělit středníkem a můžete vytvořit negativní vzor tak, že ho předponou . Příklad: .

konfigurace balíčku
Vstupní alias: . . Volitelný. Používá se při . Výchozí hodnota: .

Při použití souboru určuje tento vstup konfiguraci, která se má zabalit.

složky balíčku
Vstupní alias: . . Volitelný. Používá se při . Výchozí hodnota: .

Složka, ve které se vytvoří balíčky. Pokud je tato složka prázdná, společně se souborem se vytvoří balíčky.

Nevystavovat
. Volitelný. Používá se při . Výchozí hodnota: .

Určuje, že úkol před zabalením projekt nevytvoře. Tato úloha odpovídá parametru příkazu .

zahrnout symboly
. Volitelný. Používá se při . Výchozí hodnota: .

Vytvoří balíčky NuGet symbolu. Tato úloha odpovídá parametru příkazového řádku .

zahrnout zdrojové
. Volitelný. Používá se při . Výchozí hodnota: .

Zahrnuje zdrojový kód v balíčku. Tato úloha odpovídá parametru příkazového řádku .

automatické správy verzí balíčků
. Požadováno při . Povolené hodnoty: , (Použijte datum a čas), (Použijte proměnnou prostředí), (Použijte číslo sestavení), (Použijte plné číslo sestavení SemVer). Výchozí hodnota: .

Tento úkol nelze použít se zahrnutými odkazovanými projekty. Pokud zvolíte , vygeneruje se SemVerkompatibilní verze formátovaná jako , kde zvolíte , a .

Pokud zvolíte , musíte vybrat proměnnou prostředí a ujistit se, že obsahuje číslo verze, kterou chcete použít.

Pokud zvolíte , použije se k verzi balíčku číslo buildu. Poznámka: V části nastavte formát čísla buildu na .

proměnné prostředí
. Požadováno při .

Určuje název proměnné bez , nebo .

hlavní
Vstupní alias: . . Požadováno při . Výchozí hodnota: .

ve verzi X.Y.Z.

menší
Vstupní alias: . . Požadováno při . Výchozí hodnota: .

ve verzi X.Y.Z.

Záplata
Vstupní alias: . . Požadováno při . Výchozí hodnota: .

ve verzi X.Y.Z.

další vlastnosti sestavení
. Volitelný. Používá se při .

Určuje seznam dvojic oddělený středníky, kde každý výskyt v souboru bude nahrazen danou hodnotou. Hodnoty můžou být řetězce v uvozovkách.

podrobností
. Volitelný. Používá se při . Povolené hodnoty: , , , , , . Výchozí hodnota: .

Určuje množství podrobností zobrazených ve výstupu příkazu .

pracovního adresáře
. Volitelný. Používá se při .

Aktuální pracovní adresář, ve kterém je skript spuštěn. je kořenem úložiště (sestavení) nebo artefaktů (verze), což je .

Nastavit časový limit pro žádost o stažení balíčku
. Výchozí hodnota: .

Uveďte časovou hranici pro HTTP požadavky, které úkol provádí pro získání balíčku technologie .NET. Hodnota je v milisekundách. Výchozí hodnota je 3 00000 milisekund (5 minut). Nesmí být delší než 6 00000 milisekund (10 minut).

Možnosti řízení úkolů

Všechny úkoly mají kromě vstupů úkolů také možnosti řízení. Další informace naleznete v tématu Možnosti ovládacího prvku a běžné vlastnosti úloh.

Výstupní proměnné

Žádný.

Poznámky

Důležitý

Úkol NuGet Authenticate je novým doporučeným způsobem autentizace pomocí Azure Artifacts a dalších NuGet repozitářů. Příkazy restore a push této technologie .NET Core CLI úlohy již nepřijímají nové funkce a řeší se pouze kritické chyby.

Použití AzurePipelinesCredential v integračních testech

Knihovny Azure Identity pro technologie .NET, C++, Go, Java, JavaScript a Python podporují federaci identit zátěže, takže kód vykonávaný z úloh AzureCLI@2 a AzurePowerShell@5 může být autentizován pomocí Microsoft Entra ID (například pro přístup Azure) s použitím třídy AzurePipelinesCredential.

Mnoho zákazníků používá klientské knihovny Azure SDK v integračních testech vyvolávaných z jiných úloh. Úlohy DotNetCoreCLI@2, Maven@4 a VSTest@3 mají přístup k Azure zdrojům pomocí třídy AzurePipelinesCredential.

Můžete nastavit vlastnost connectedServiceName na Azure připojení ke službě nakonfigurované s federací identity zátěže. vyžaduje nastavení SYSTEM_ACCESSTOKEN.

Následující příklad ukazuje vstup úlohy . a využití je podobné.

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

Pro více informací o AzurePipelinesCredential viz Improve security posture in Azure service connections with AzurePipelinesCredential.

Proč se mému sestavení, publikování nebo testovacímu kroku nedaří obnovit balíčky?

Většina příkazů , včetně , a , zahrnuje implicitní krok. To selže s ověřenými informačními kanály, i když jste v předchozím kroku spustili úspěšnou , protože předchozí krok vyčistí použité přihlašovací údaje.

Pokud chcete tento problém vyřešit, přidejte do textového pole příznak .

Příkaz navíc nerozpozná ani argumenty a kanály zadané tímto způsobem nebudou zahrnuty do vygenerovaného souboru při spuštění implicitního kroku . K obnovení balíčků se doporučuje explicitní krok. Příkaz respektuje a argumenty.

Proč se mi při vytváření na počítači zobrazuje upozornění NU1507 s mapováním zdrojů balíčků i když při sestavování na mém počítači nemá žádná upozornění?

Různé příkazy, které provede obnovení NuGetu nebo přistupují k informačnímu kanálu NuGet, sestaví speciální dočasný soubor, který přidá ověřování NuGet pro kanály NuGet artefaktů Azure. Postup je v konfliktu se schématem, které mapování zdrojů balíčků používá k mapování balíčků na zdroje a přeruší konfiguraci mappin zdroje balíčku v souboru ve vašem úložišti. Chcete-li tento konflikt obejít, můžete použít úlohu Ověření NuGet k ověření a následnému vytvoření vlastního příkazu vyvolat požadovaný příkaz dotnet bez úpravy.

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

Proč mám vrátit se změnami NuGet.config?

Kontrola do správy zdrojového kódu zajišťuje, že je pro každého vývojáře, který váš kód kontroluje, k dispozici klíčové informace potřebné k sestavení projektu – umístění jeho balíčků.

Nicméně v situacích, kdy tým vývojářů pracuje na širokém spektru projektů, je také možné přidat Azure Artifacts feed do globálního NuGet.config na každém počítači vývojáře. V těchto situacích se tato konfigurace replikuje pomocí možnosti v úloze NuGet.

Řešení problémů

Projekt využívající Entity Framework přestal fungovat na hostovaných agentech

technologie .NET Core nemá vestavěný Entity Framework (EF). Buď budete muset EF nainstalovat před začátkem spouštění, nebo přidat global.json do projektu s požadovanou verzí technologie .NET Core SDK. Tím zajistíte, že se k sestavení projektu EF použije správná sada SDK. Pokud na počítači není požadovaná verze, přidejte do kanálu úlohu a nainstalujte požadovanou verzi. Pro více informací viz Get the Entity Framework Core runtime.

Příklady

• příklady sestavení
• příklady nabízených oznámení
• příklady nabízených oznámení
• Příklady sady Pack
• Příklady publikování
• Příklady obnovení
• příklady testů

Příklady sestavení

Sestavení projektu

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

Sestavení více projektů

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

Příklady nabízených oznámení

Nabízení balíčků NuGet do interního informačního kanálu

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

Nabízení balíčků NuGet do externího informačního kanálu

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

Příklady balíčků

Zabalení balíčku NuGetPackage do konkrétního výstupního adresáře

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

Zabalení balíčku symbolů

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

Příklady publikování

Publikování projektů do zadané složky

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

Příklady obnovení

#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

Příklady testů

Spouštění testů v úložišti

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

Požadavky

Požadavek	Popis
Typy kanálů	YAML, klasické sestavení, klasická verze
Běží na	Agenta
požadavky	Žádný
možnosti	Tento úkol nesplňuje žádné požadavky na následné úkoly v úloze.
omezení příkazů	Jakýkoliv
nastavitelné proměnné	Jakýkoliv
Verze agenta	2.144.0 nebo vyšší
Kategorie úkolu	Vybudovat