mirror of https://github.com/renovatebot/renovate.git synced 2025-01-16 01:26:24 +00:00

2022-01-28 19:35:53 +01:00

3.6 KiB

Raw Blame History

title	description
NuGet (.NET)	NuGet (.NET) dependencies support in Renovate

NuGet

Renovate supports upgrading dependencies in .csproj, .fsproj, and .vbproj files.

Version Support

Only SDK-style .csproj/.fsproj/.vbproj files are currently supported. By default, this includes:

.NET Core 1.0 and above
.NET Standard class libraries
Any .csproj/.fsproj/.vbproj in the SDK-style syntax

To convert your .NET Framework .csproj/.fsproj/.vbproj into an SDK-style project, follow the steps in this guide.

How it works

Renovate searches in each repository for any files with a .csproj, .fsproj, or .vbproj extension
Existing dependencies are extracted from <PackageReference> and <PackageVersion> tags
Renovate looks up the latest version on nuget.org (or on alternate feeds) to determine if any upgrades are available
If the source package includes a GitHub URL as its source, and has either a "changelog" file or uses GitHub releases, then release notes for each version are embedded in the generated PR

If your project file references a packages.config file, no dependencies will be extracted. Find out here how to migrate from packages.config to PackageReference.

Alternate feeds

By default Renovate performs all lookups on https://api.nuget.org/v3/index.json, but you can configure alternative NuGet feeds. Alternative feeds can be specified either in a NuGet.config file within your repository (Renovate will not search outside the repository) or in Renovate configuration options:

{
  "nuget": {
    "registryUrls": [
      "https://api.nuget.org/v3/index.json",
      "https://example1.com/nuget/",
      "https://example2.com/nuget/v3/index.json"
    ]
  }
}

In this example we defined 3 NuGet feeds. The package resolving process uses the merge strategy to handle the 3 feeds. All feeds are checked for dependency updates, and duplicate updates are merged/joined together into a single dependency update.

If your project uses lockfiles (a package.lock.json exists), alternate feed settings must be defined in a NuGet.config only, as registryUrls are not passed through to the NuGet commands used.

Protocol versions

NuGet supports two protocol versions, v2 and v3, the NuGet client and server must use the same protocol version. Renovate as a NuGet client supports both versions and will use v2 unless the configured feed URL ends with index.json (which mirrors the behavior of the official NuGet client). If you have a v3 feed that does not match this pattern (e.g. JFrog Artifactory) you need to help Renovate by appending #protocolVersion=3 to the registry URL:

{
  "nuget": {
    "registryUrls": ["http://myV3feed#protocolVersion=3"]
  }
}

Authenticated feeds

Credentials for authenticated/private feeds can be provided via host rules in the configuration options (file or command line parameter).

{
  "hostRules": [
    {
      "hostType": "nuget",
      "matchHost": "http://example1.com/nuget",
      "username": "root",
      "password": "p4$$w0rd"
    }
  ]
}

!!! note At the moment only Basic HTTP authentication (via username and password) is supported.

Future work

Contributions and/or feature requests are welcome to support more patterns or additional use cases.

3.6 KiB Raw Blame History