Skip to content

Latest commit

 

History

History
124 lines (104 loc) · 3.82 KB

nuget-updater.md

File metadata and controls

124 lines (104 loc) · 3.82 KB
Raw
uid
uno.tools.nuget.updater

About

NuGet.Updater allows batch updates of NuGet packages found in solutions.

Getting Started

The NuGet Updater can be installed as a standalone .Net Core tool using the following command: dotnet tool install -g unoplatform.NuGet.Updater.Tool

Help can be found with : nugetupdater --help

The NuGet Updater can also be used as part of the NvGet library

Sample commands

  • Update all packages in the current folder (and its subfolders) to the latest stable version found on NuGet.org
nugetupdater --useNuGetorg

This can also be achieved using the following command

nugetupdater --feed=https://api.nuget.org/v3/index.json
  • Update all packages in MySolution.sln to the latest stable version available on NuGet.org
nugetupdater --solution=MySolution.sln -n
  • Update packages to either beta, stable or alpha (whichever's the highest)
nugetupdater -s=MySolution.sln -n --version=beta -v=alpha
  • Update packages to the latest beta version available on a private feed
nugetupdater -s=MySolution.sln --feed=https://pkgs.dev.azure.com/account/_packaging/feed/nuget/v3/index.json|personalaccesstoken --version=beta
  • Update packages from unoplatform from NuGet.org, except for PackageA and PackageB
nugetupdater -s=MySolution.sln -n --packageAuthor=unoplatform --ignore=PackageA -i=PackageB
  • Update packages from unoplatform and microsoft from NuGet.org, except for PackageA and PackageB
nugetupdater -s=MySolution.sln -n --packageAuthor=unoplatform,microsoft --ignore=PackageA -i=PackageB
  • Update only PackageA and PackageB from NuGet.org and a private feed
nugetupdater -s=MySolution.sln -n -f=https://pkgs.dev.azure.com/account/_packaging/feed/nuget/v3/index.json|personalaccesstoken --update=PackageA -u=PackageB
  • Update packages to latest stable, even if a higher version is already found in the solution
nugetupdater -s=MySolution.sln -n --allowDowngrade

nugetupdater -s=MySolution.sln -n -v=dev -v=stable --allowDowngrade --versionOverrides=versions.json

versions.json example:

[
  {
    "PackageId": "Uno.UI",
    "UpdatedVersion": "2.3.0-dev.76" -> Force 2.3.0-dev.76
  },
  {
    "PackageId": "Uno.Wasm.Bootstrap",
    "UpdatedVersion": "(,1.2.0-dev.18]" -> Resolves 1.2.0-dev.18 (-v=dev + -v=stable), 1.0.10 (-v=stable)
  },
  {
    "PackageId": "Uno.WinUI",
    "UpgradePolicy": "Minor" -> Only upgrades when a minor version of the same major is available
  },
  {
    "PackageId": "Uno.Core",
    "UpgradePolicy": "Major" -> Always upgrades
  },
  {
    "PackageId": "Uno.Core.Extensions",
    "UpgradePolicy": "Patch" -> Only upgrades when a patch version of the same major,minor is available
  }
]
  • Update versions tracked in project properties. eg:
<UnoVersion>4.9.26</UnoVersion>
nugetupdater -s=MySolution.sln -n -v=dev -v=stable --allowDowngrade --updateProperties=properties.json

properties.json example:

[
  {
    "PropertyName": "UnoVersion",
    "PackageId": "Uno.UI"
  }
]

In this case the UnoVersion property will be updated to the latest version of Uno.UI found in the solution.

Supported types of updates

The nuget updater supports updating:

  • .csproj, Directory.Build.props, Directory.Build.targets and Directory.Packages.props For this type of files, the tool will update:
    • PackageReference and PackageVersion items
    • MSBuild properties using named this way UnoWinUIVersion or UnoExtensionsNavigationVersion
  • .nuspec For this type of files, the tool will update reference entries.
  • global.json For this type of files, the tool will update msbuild-sdk entries