NuGetCommand@2 — задача NuGet версии 2

Используйте эту задачу для восстановления, упаковки или отправки пакетов NuGet или выполнения команды NuGet. Эта задача поддерживает NuGet.org и веб-каналы, прошедшие проверку подлинности, такие как Azure Artifacts и MyGet. Эта задача также использует NuGet.exe и работает с платформа .NET Framework приложениями. Для приложений .NET Core и .NET Standard используйте задачу .NET Core.

Синтаксис

# NuGet v2
# Restore, pack, or push NuGet packages, or run a NuGet command. Supports NuGet.org and authenticated feeds like Azure Artifacts and MyGet. Uses NuGet.exe and works with .NET Framework apps. For .NET Core and .NET Standard apps, use the .NET Core task.
- task: NuGetCommand@2
  inputs:
    command: 'restore' # 'restore' | 'pack' | 'push' | 'custom'. Required. Command. Default: restore.
    restoreSolution: '**/*.sln' # string. Alias: solution. Required when command = restore. Path to solution, packages.config, or project.json. Default: **/*.sln.
    #packagesToPush: '$(Build.ArtifactStagingDirectory)/**/*.nupkg;!$(Build.ArtifactStagingDirectory)/**/*.symbols.nupkg' # string. Alias: searchPatternPush. Required when command = push. Path to NuGet package(s) to publish. Default: $(Build.ArtifactStagingDirectory)/**/*.nupkg;!$(Build.ArtifactStagingDirectory)/**/*.symbols.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. 
    #allowPackageConflicts: false # boolean. Optional. Use when command = push && nuGetFeedType = internal. Allow duplicates to be skipped. Default: false.
    #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).
    #packDestination: '$(Build.ArtifactStagingDirectory)' # string. Alias: outputDir. Optional. Use when command = pack. Package folder. Default: $(Build.ArtifactStagingDirectory).
    #arguments: # string. Required when command = custom. Command and arguments. 
  # 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/TFS 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.
    #disableParallelProcessing: false # boolean. Optional. Use when command = restore. Disable parallel processing. Default: false.
    #restoreDirectory: # string. Alias: packagesDirectory. Optional. Use when command = restore. Destination directory. 
    #verbosityRestore: 'Detailed' # 'Quiet' | 'Normal' | 'Detailed'. 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.
    #verbosityPush: 'Detailed' # 'Quiet' | 'Normal' | 'Detailed'. Optional. Use when command = push. Verbosity. Default: Detailed.
  # Pack options
    #versioningScheme: 'off' # 'off' | 'byPrereleaseNumber' | 'byEnvVar' | 'byBuildNumber'. Required when command = pack. Automatic package versioning. Default: off.
    #includeReferencedProjects: false # boolean. Optional. Use when versioningScheme = off && command = pack. Include referenced projects. Default: false.
    #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.
    #packTimezone: 'utc' # 'utc' | 'local'. Optional. Use when versioningScheme = byPrereleaseNumber && command = pack. Time zone. Default: utc.
    #includeSymbols: false # boolean. Optional. Use when command = pack. Create symbols package. Default: false.
    #toolPackage: false # boolean. Optional. Use when command = pack. Tool Package. Default: false.
  # Advanced
    #buildProperties: # string. Optional. Use when command = pack. Additional build properties. 
    #basePath: # string. Optional. Use when command = pack. Base path. 
    #verbosityPack: 'Detailed' # 'Quiet' | 'Normal' | 'Detailed'. Optional. Use when command = pack. Verbosity. Default: Detailed.

Входные данные

command - Команды
string. Обязательный. Допустимые значения: restore, pack, push, custom. Значение по умолчанию: restore.

Указывает выполняемую команду NuGet. Используйте значение , custom чтобы добавить аргументы или использовать другую команду.

restoreSolution - Путь к решению, packages.config или project.json
Входной псевдоним: solution. string. Требуется при .command = restore Значение по умолчанию: **/*.sln.

Указывает путь к решению, или project.json файлу, packages.configкоторый ссылается на восстанавливаемые пакеты.

feedsToUse - Используемые веб-каналы
Входной псевдоним: selectOrConfig. string. Требуется при .command = restore Допустимые значения: select (Веб-каналы, которые я выбираю здесь), config (Веб-каналы в моем NuGet.config). Значение по умолчанию: select.

Указывает веб-канал из Azure Artifacts и (или) NuGet.org для задачи, который будет использоваться со значением select . Кроме того, можно зафиксировать файл в NuGet.config репозитории исходного кода и задать путь к нему в качестве значения с помощью config значения .

vstsFeed - Использование пакетов из этого веб-канала Azure Artifacts/TFS
Входной псевдоним: feedRestore. string. Необязательный элемент. Используйте при selectOrConfig = select && command = restore.

Указывает выбранный веб-канал в созданном объекте NuGet.config. Для указания веб-канала необходимо установить и лицензировать управление пакетами.

includeNuGetOrg - Использование пакетов из NuGet.org
boolean. Необязательный элемент. Используйте при selectOrConfig = select && command = restore. Значение по умолчанию: true.

Включает NuGet.org в созданный NuGet.configобъект .

nugetConfigPath - Путь к NuGet.config
string. Необязательный элемент. Используйте при selectOrConfig = config && command = restore.

Указывает путь к объекту в NuGet.config репозитории, который определяет веб-каналы, из которых нужно восстановить пакеты.

externalFeedCredentials - Учетные данные для веб-каналов за пределами этой организации или коллекции
Входной псевдоним: externalEndpoints. string. Необязательный элемент. Используйте при selectOrConfig = config && command = restore.

Указывает учетные данные, используемые для внешних реестров, расположенных в выбранном NuGet.configобъекте . Это имя подключения к службе NuGet. Для веб-каналов в этой организации или коллекции оставьте это поле пустым; учетные данные сборки используются автоматически.

noCache - Отключение локального кэша
boolean. Необязательный элемент. Используйте при command = restore. Значение по умолчанию: false.

Запрещает NuGet использовать пакеты из кэшей локальных компьютеров, если задано значение true.

disableParallelProcessing - Отключение параллельной обработки
boolean. Необязательный элемент. Используйте при command = restore. Значение по умолчанию: false.

Запрещает NuGet устанавливать несколько пакетов в параллельных процессах, если задано значение true.

restoreDirectory - Целевой каталог
Входной псевдоним: packagesDirectory. string. Необязательный элемент. Используйте при command = restore.

Указывает папку, в которой устанавливаются пакеты. Если папка не указана, пакеты восстанавливаются в папку packages/ вместе с выбранным решением , packages.configили project.json.

verbosityRestore - Детализации
string. Необязательный элемент. Используйте при command = restore. Допустимые значения: Quiet, Normal, Detailed. Значение по умолчанию: Detailed.

Указывает объем сведений, отображаемых в выходных данных.

packagesToPush - Путь к пакетам NuGet для публикации
Входной псевдоним: searchPatternPush. string. Требуется при .command = push Значение по умолчанию: $(Build.ArtifactStagingDirectory)/**/*.nupkg;!$(Build.ArtifactStagingDirectory)/**/*.symbols.nupkg.

Указывает шаблон для сопоставления или путь к файлам для nupkg отправки. Несколько шаблонов можно разделить точкой с запятой.

nuGetFeedType - Расположение целевого веб-канала
string. Требуется при .command = push Допустимые значения: internal (эта организация или коллекция), external (внешний сервер NuGet (включая другие учетные записи или коллекции)). Значение по умолчанию: internal.

Указывает, является ли целевой веб-канал внутренним веб-каналом или коллекцией или внешним сервером NuGet.

publishVstsFeed - Целевой веб-канал
Входной псевдоним: feedPublish. string. Требуется при .command = push && nuGetFeedType = internal

Указывает веб-канал, размещенный в этой учетной записи. Для выбора веб-канала необходимо установить и лицензировать Azure Artifacts.

publishPackageMetadata - Публикация метаданных конвейера
boolean. Необязательный элемент. Используйте при command = push && nuGetFeedType = internal && command = push. Значение по умолчанию: true.

Изменяет номер версии подмножества измененных пакетов в наборе постоянно публикуемых пакетов.

allowPackageConflicts - Разрешить пропуск дубликатов
boolean. Необязательный элемент. Используйте при command = push && nuGetFeedType = internal. Значение по умолчанию: false.

Сообщает об успешном выполнении задачи, даже если некоторые пакеты отклонены с ошибками конфликта 409.

В настоящее время этот параметр доступен только в агентах Azure Pipelines и Windows. Если NuGet.exe возникнет конфликт, задача завершится сбоем. Этот параметр не будет работать, и публикация завершится ошибкой, если вы находитесь в среде прокси-сервера.

publishFeedCredentials - Сервер NuGet
Входной псевдоним: externalEndpoint. string. Требуется, если command = push && nuGetFeedType = external.

Указывает подключение службы NuGet, содержащее учетные данные внешнего сервера NuGet.

verbosityPush - Детализации
string. Необязательный элемент. Используйте при command = push. Допустимые значения: Quiet, Normal, Detailed. Значение по умолчанию: Detailed.

Указывает объем сведений, отображаемых в выходных данных.

packagesToPack - Путь к файлам csproj или nuspec для упаковки
Входной псевдоним: searchPatternPack. string. Требуется, если command = pack. Значение по умолчанию: **/*.csproj.

Указывает шаблон, используемый задачей для поиска каталогов csproj для упаковки.

Вы можете разделить несколько шаблонов точкой с запятой и сделать шаблон отрицательным, указав для него !префикс . Например, **\*.csproj;!**\*.Tests.csproj.

configuration - Конфигурация для упаковки
Входной псевдоним: configurationToPack. string. Необязательный элемент. Используйте при command = pack. Значение по умолчанию: $(BuildConfiguration).

Указывает конфигурацию для упаковки при использовании CSPROJ-файла.

packDestination - Папка пакета
Входной псевдоним: outputDir. string. Необязательный элемент. Используйте при command = pack. Значение по умолчанию: $(Build.ArtifactStagingDirectory).

Указывает папку, в которой задача создает пакеты. Если значение пустое, задача создает пакеты в корневом каталоге источника.

versioningScheme - Автоматическое управление версиями пакетов
string. Требуется, если command = pack. Допустимые значения: off, byPrereleaseNumber (используйте дату и время), byEnvVar (используйте переменную среды), byBuildNumber (используйте номер сборки). Значение по умолчанию: off.

Применяет автоматическое управление версиями пакетов в зависимости от указанного значения. Эту строку нельзя использовать с includeReferencedProjects. Допустимые значения:

• byPrereleaseNumber - Использование даты и времени. Задача создаст версию, совместимую с SemVer, в формате X.Y.Z-ci-datetime, где указываются значения X, Y и Z.
• byEnvVar- Использовать переменную среды. Задача будет использовать указанную переменную среды и содержит номер версии, который вы хотите использовать.
• byBuildNumber - Использовать номер сборки. Задача будет использовать номер сборки для выпуска пакета.

Примечание

В разделе Общие задайте для сборки формат $(BuildDefinitionName)_$(Year:yyyy).$(Month).$(DayOfMonth)$(Rev:.r).

includeReferencedProjects - Включение проектов, на которые имеются ссылки
boolean. Необязательный элемент. Используйте при versioningScheme = off && command = pack. Значение по умолчанию: false.

Включает проекты, на которые имеются ссылки, как зависимости или как часть пакета. Не может использоваться с автоматическим управлением версиями пакетов. Если упоминаемый проект имеет соответствующий nuspec файл с тем же именем, что и проект, этот проект добавляется в качестве зависимости. В противном случае проект, на который указывает ссылка, добавляется как часть пакета. Узнайте больше об использовании команды pack для Интерфейса командной строки NuGet для создания пакетов NuGet.

versionEnvVar - Переменная среды
string. Требуется, если versioningScheme = byEnvVar && command = pack.

Указывает имя переменной без $, $envили %.

majorVersion - Основных
Входной псевдоним: requestedMajorVersion. string. Требуется, если versioningScheme = byPrereleaseNumber && command = pack. Значение по умолчанию: 1.

В X версии X.Y.Z.

minorVersion - Незначительные
Входной псевдоним: requestedMinorVersion. string. Требуется, если versioningScheme = byPrereleaseNumber && command = pack. Значение по умолчанию: 0.

В Y версии X.Y.Z.

patchVersion - Патч
Входной псевдоним: requestedPatchVersion. string. Требуется, если versioningScheme = byPrereleaseNumber && command = pack. Значение по умолчанию: 0.

В Z версии X.Y.Z.

packTimezone - Часовой пояс
string. Необязательный элемент. Используйте при versioningScheme = byPrereleaseNumber && command = pack. Допустимые значения: utc, local (местное время агента). Значение по умолчанию: utc.

Указывает требуемый часовой пояс, используемый для создания версии пакета. utc Рекомендуется выбирать, если вы используете размещенные агенты сборки, так как их дата и время могут отличаться.

includeSymbols - Создание пакета символов
boolean. Необязательный элемент. Используйте при command = pack. Значение по умолчанию: false.

Указывает, что пакет содержит источники и символы. При использовании с файлом .nuspec создается обычный файл пакета NuGet и соответствующий пакет символов.

toolPackage - Пакет инструментов
boolean. Необязательный элемент. Используйте при command = pack. Значение по умолчанию: false.

Определяет, должны ли выходные файлы проекта находиться в папке средства.

buildProperties - Дополнительные свойства сборки
string. Необязательный элемент. Используйте при command = pack.

Указывает список пар token=value, разделенных точкой с запятой, где каждое вхождение $token$ в .nuspec файле будет заменено заданным значением. Значения могут быть строками в кавычках.

basePath - Базовый путь
string. Необязательный элемент. Используйте при command = pack.

Указывает базовый путь к файлам, определенным в nuspec файле.

verbosityPack - Детализации
string. Необязательный элемент. Используйте при command = pack. Допустимые значения: Quiet, Normal, Detailed. Значение по умолчанию: Detailed.

Указывает объем сведений, отображаемых в выходных данных.

arguments - Команда и аргументы
string. Требуется при .command = custom

Указывает команду и аргументы, которые будут переданы для NuGet.exe выполнения. Если используется NuGet 3.5 или более поздней версии, аутентифицированные команды, такие как list, restoreи publish для любого веб-канала в этой организации или коллекции, к которым имеет доступ служба сборки коллекции Проектов, будут автоматически проходить проверку подлинности.

Параметры управления задачами

Помимо входных данных, все задачи имеют параметры управления. Дополнительные сведения см. в разделе Параметры управления и общие свойства задачи.

Выходные переменные

Нет.

Remarks

Важно!

Задача Проверки подлинности NuGet — это новый рекомендуемый способ проверки подлинности с помощью Azure Artifacts и других репозиториев NuGet. Эта задача больше не использует новые функции, и устраняются только критические ошибки.

Используйте эту задачу для установки и обновления зависимостей пакетов NuGet или упаковки и публикации пакетов NuGet. Использует NuGet.exe и работает с приложениями .NET Framework. Для приложений .NET Core и .NET Standard используйте задачу .NET Core.

Если ваш код зависит от пакетов NuGet, обязательно добавьте этот шаг перед задачей сборки Visual Studio. Кроме того, не забудьте снять флажок Восстановить пакеты NuGet в этой задаче.

Если вы работаете с .NET Core или .NET Standard, используйте задачу .NET Core , которая имеет полную поддержку для всех сценариев пакета и в настоящее время поддерживается dotnet.

Совет

Эта версия задачи NuGet по умолчанию использует NuGet 4.1.0. Чтобы выбрать другую версию NuGet, используйте установщик инструментов.

Схемы управления версиями

Для byPrereleaseNumber в качестве версии будут заданы значения, выбранные для основной версии, дополнительной версии и исправления, а также дата и время в формате yyyymmdd-hhmmss.

Для byEnvVar в качестве версии будет задано значение переменной среды с именем, указанным параметром versionEnvVar , например MyVersion (нет $, только имя переменной среды). Убедитесь, что для переменной среды задано правильное значение SemVer, например 1.2.3 или 1.2.3-beta1.

Для byBuildNumber версия будет задана с помощью номера сборки запуска конвейера. Это значение, указанное для свойства конвейера name , которое сохраняется в переменной BUILD_BUILDNUMBER среды). Убедитесь, что используемый номер сборки содержит соответствующий объект SemVer, например 1.0.$(Rev:r). При использовании byBuildNumber задача извлекает пунктирную версию 1.2.3.4, , из строки номера сборки и использует только эту часть. Остальная часть строки будет удалена. Если вы хотите использовать номер сборки как есть, можно использовать byEnvVar , как описано выше, и задать для versionEnvVar значение BUILD_BUILDNUMBER.

Миграция из NuGetInstaller@0 или NuGetRestore@1

NuGetInstaller@0 и NuGetRestore@1 являются устаревшими, и их следует заменить в конвейере на NuGetCommand@2.

Если вы использовали NuGetInstaller@0 с restoreMode: restore, настройте следующие входные данные при использовании NuGetCommand@2.

входные данные задачи NuGetCommand@2	Значение
command	restore
restoreSolution	Путь к файлу .sln

Если вы использовали NuGetInstaller@0 с restoreMode: install, настройте следующие входные данные при использовании NuGetCommand@2.

входные данные задачи NuGetCommand@2	Значение
command	custom
arguments	Как будет выглядеть команда полной установки в Интерфейсе командной строки NuGet. Например, если вы хотите запустить эквивалент nuget install ninject -OutputDirectory c:\proj в конвейере, то arguments параметр будет иметь значение install ninject -OutputDirectory c:\proj. Если вы использовали параметр , NuGetInstaller@0nuGetRestoreArgs они также теперь входят в arguments.

Если вы использовали NuGetRestore@1, настройте следующие входные данные при использовании NuGetCommand@2.

входные данные задачи NuGetCommand@2	Значение
command	restore
restoreSolution	Путь к файлу .sln

Аналогично параметру или , имеет входные данные, чтобы задать веб-канал, выбрать или configselect , указать путь к файлу NuGet.config и использовать пакеты из nuget.org. NuGetCommand@2NuGetRestore@1NuGetInstaller@0restore

Дополнительные сведения см. в следующих примерах.

Примеры

Восстановить

Восстановите все решения с помощью пакетов из выбранного веб-канала.

# Restore from a project scoped feed in the same organization
- task: NuGetCommand@2
  inputs:
    command: 'restore'
    feedsToUse: 'select'
    vstsFeed: 'my-project/my-project-scoped-feed'
    includeNuGetOrg: false
    restoreSolution: '**/*.sln'

# Restore from an organization scoped feed in the same organization
- task: NuGetCommand@2
  inputs:
    command: 'restore'
    feedsToUse: 'select'
    vstsFeed: 'my-organization-scoped-feed'
    restoreSolution: '**/*.sln'

# Restore from a feed in a different organization
- task: NuGetCommand@2
  inputs:
    command: 'restore'
    feedsToUse: config
    nugetConfigPath: ./nuget.config
    restoreSolution: '**/*.sln'
    externalFeedCredentials: 'MyServiceConnectionName'
    noCache: true
  continueOnError: true

# Restore from feed(s) set in nuget.config
- task: NuGetCommand@2
  inputs:
    command: 'restore'
    feedsToUse: 'config'
    nugetConfigPath: 'nuget.config'

Пакет

Создайте пакет NuGet в папке назначения.

# Package a project
- task: NuGetCommand@2
  inputs:
    command: 'pack'
    packagesToPack: '**/*.csproj'
    packDestination: '$(Build.ArtifactStagingDirectory)'

push

Примечание

Артефакты конвейера загружаются в Pipeline.Workspace каталог и в System.ArtifactsDirectory каталог для классических конвейеров выпуска. packagesToPush можно задать $(Pipeline.Workspace)/**/*.nupkg значение или $(System.ArtifactsDirectory)/**/*.nupkg соответственно.

• Отправка или публикация пакета в канале, определенном в NuGet.config.

  # Push a project
  - task: NuGetCommand@2
    inputs:
      command: 'push'
      packagesToPush: '$(Build.ArtifactStagingDirectory)/**/*.nupkg'
      feedsToUse: 'config'
      nugetConfigPath: '$(Build.WorkingDirectory)/NuGet.config'
  

• Отправка или публикация пакета в веб-канале организации

  # Push a project
  - task: NuGetCommand@2
    inputs:
      command: 'push'
      nuGetFeedType: 'internal'
      publishVstsFeed: 'my-organization-scoped-feed'
  

• Отправка или публикация пакета в веб-канале с областью проекта

  # Push a project
  - task: NuGetCommand@2
    inputs:
      command: 'push'
      nuGetFeedType: 'internal'
      publishVstsFeed: 'my-project/my-project-scoped-feed'
  

• Отправка или публикация пакета в NuGet.org

  # Push a project
  - task: NuGetCommand@2
    inputs:
      command: 'push'
      feedsToUse: 'config'
      includeNugetOrg: 'true'
  

Особые настройки

Выполните любую другую команду NuGet, кроме команд по умолчанию: pack, push и restore.

# list local NuGet resources.
- task: NuGetCommand@2
  displayName: 'list locals'
  inputs:
    command: custom
    arguments: 'locals all -list'

Требования

Требование	Описание
Типы конвейеров	YAML, классическая сборка, классический выпуск
Выполняется в	Агент, DeploymentGroup
Требования	None
Capabilities	Эта задача не удовлетворяет требованиям для последующих задач в задании.
Ограничения команд	Любой
Устанавливаемые переменные	Любой
Версия агента	2.144.0 или более поздней версии
Категория задач	Пакет