Dotnet tool for updating package reference and dotnet-tools.json.
The tool will try to stick to package versions that is supported by the projects target framework moniker. If a package supports both .NETStandard and .NET, the compatibility with .NETStandard will be ignored if the project is targeting .NET. This is to avoid false positives where a package technically supports a TFM but in reality never have been tested against the TFM.
See UpdatR for SDK.
> dotnet tool install --global dotnet-updatr
To update all *.csproj and dotnet-tools.json recursively:
> update
If you only want to update the *.csproj and dotnet-tools.json that is part of a solution you can specify the solution directly:
> update path/to/solution.sln
You can also update a single *.csproj or dotnet-config.json:
> update path/to/example.csproj
If you want to preview the result you can do a dry run:
> update --dry-run
For larger solutions with multiple packages the console output is not optimal. You can choose to view the result in your default browser instead:
> update --browser
To allow packages to be updated to prerelease versions use the --prerelease options:
> update --prerelease
To update only one or more specific packages you can use the --package option:
> update --package Microsoft.* --package Newtonsoft.*
If you don't want to update a package or packages you can exclude them:
> update --exclude-package Microsoft.* --exclude-package Newtonsoft.*
If UpdatR fails to find the correct lowest TFM to support, for example for projects that supports multiple TFM's, then it's possible to set the TFM manually:
> update --tfm net6.0
You can get the output as a markdown by setting a path for the output:
> update --output path/to/output/folder
It's possible to get the title and the rest of the output as separate .md-files which is helpful when creating a pull request:
> update --title path/to/title.md --description path/to/description.md
then you can use title.md as the title for your pull request and description.md as the body.
UpdatR is used to update it's own dependencies, have a look at Build.cs for an example that uses Bullseye and SimpleExec. However, if you are using C# in your CI/CD pipeline it's probably easier to just use UpdatR directly instead. That's the package that powers dotnet-updatr under the hood.
Usage:
update [<args>] [options]
Arguments:
<args> Path to solution or project(s). Defaults to current folder. Target can be a specific file or folder. If target is a folder then all *.csproj-files and dotnet-config.json-files will be processed. [default: .]
Options:
--package <package> Package to update. Supports * as wildcard. Will update all unless specified. []
--exclude-package <exclude-package> Package to exclude. Supports * as wildcard. []
--output <output> Defaults to "output.md". Explicitly set to fileName.txt to generate plain text instead of markdown. []
--title <title> Outputs title to path. []
--description <description> Outputs description to path. []
--verbosity <Critical|Debug|Error|Information|None|Trace|Warning> Log level. [default: Warning]
--dry-run Do not save any changes. [default: False]
--prerelease Allow prerelease packages to be installed. [default: False]
--browser Open summary in browser. [default: False]
--interactive Interaction with user is possible. [default: False]
--tfm <tfm> Lowest TFM to support. []
--version Show version information
-?, -h, --help Show help and usage information
NuGet package to programmatically update package reference and dotnet-tools.json.
The tool will try to stick to package versions that is supported by the projects target framework moniker. If a package supports both .NETStandard and .NET, the compatibility with .NETStandard will be ignored if the project is targeting .NET. This is to avoid false positives where a package technically supports a TFM but in reality never have been tested against the TFM.
See dotnet-updatr for a dotnet tool that can be run from the command-line.
using UpdatR;
using UpdatR.Formatters;
var updatr = new Updater(); // Can take an ILogger
var summary = await updatr.UpdateAsync("path");
if (summary.UpdatedPackagesCount == 0) // No packages where updated
{
return;
}
var title = MarkdownFormatter.GenerateTitle(summary);
var description =
"# PR created automatically by UpdatR"
+ Environment.NewLine
+ Environment.NewLine
+ MarkdownFormatter.GenerateDescription(summary);
// Use title as title in the PR and description as the description/body in the PRPackage by Sergey Novosyolov from NounProject.com
