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

Используйте эту задачу для восстановления, упаковки или отправки пакетов NuGet или выполнения команды NuGet. Эта задача поддерживает NuGet.org и прошедшие проверку подлинности веб-каналы, такие как Артефакты Azure и 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. 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.
    #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. 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.

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

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

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

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

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

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

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

Путь к NuGet.confignugetConfigPath -
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. Значение по умолчанию: 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, имеющий то же имя, что и проект, то этот ссылающийся проект добавляется в качестве зависимости. В противном случае указанный проект добавляется как часть пакета. Дополнительные сведения о с помощью команды пакета для Интерфейса командной строки 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 для любого веб-канала в этой организации или коллекции, к которым служба сборки проекта имеет доступ, будет автоматически проходить проверку подлинности.

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

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

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

Никакой.

Замечания

Важный

Задача аутентификации NuGet — это новый рекомендуемый способ проверки подлинности с помощью Артефактов Azure и других репозиториев 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, как описано выше, и задать для значение 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

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

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

Поддержка новых размещенных образов Ubuntu

Начиная с Ubuntu 24.04, размещенные в Microsft агенты не будут отправляться с моно, который требуется для запуска базового клиента NuGet, который выполняет NuGetCommand@2. Пользователи этой задачи в Ubuntu должны перейти на долгосрочную кроссплатформенную задачу NuGetAuthenticate@1 с помощью .NET CLI.

Миграция в .NET CLI в Ubuntu

Задача аутентификации NuGet будет обрабатывать внедрение учетных данных в необходимые места для проверки подлинности клиентских средств в качестве удостоверения конвейера. См. связанную документацию по инструкциям, часто задаваемым вопросам и примерам использования NuGet Authenticate с dotnet.

Если команды dotnet CLI не поддерживают сценарий, сообщите об этом команде .NET CLI в качестве проблемы. Вы можете продолжать закрепить образ агента для Ubuntu 22.04 или более ранних версий. Поддержка Ubuntu 22.04 будет продолжаться до тех пор, пока Ubuntu 26.04 не станет общедоступной, не более 2026 года.

Примеры

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

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

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

Толкать

Заметка

Артефакты конвейера загружаются в каталог 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, помимо стандартных: пакет, отправка и восстановление.

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

Требования

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