Skip to content
Snippets Groups Projects
Unverified Commit 4751bb1a authored by HonkingGoose's avatar HonkingGoose Committed by GitHub
Browse files

docs: improve NuGet documentation (#7826)


* use 1's for ordered list, fix whitespace

* use active voice

* fix typo: if -> in

* capitalize word Renovate

* rewrite sentences for clarity

* rewrite for clarity

* fix grammar

* use active voice

Co-authored-by: default avatarRhys Arkins <rhys@arkins.net>
parent eb33a4d9
No related branches found
No related tags found
No related merge requests found
......@@ -19,10 +19,10 @@ To convert your .NET Framework `.csproj`/`.fsproj`/`.vbproj` into an SDK-style p
## How It Works
1. Renovate will search each repository for any files with a `.csproj`, `.fsproj`, or `.vbproj` extension
2. Existing dependencies will be extracted from `<PackageReference>` and `<PackageVersion>` tags
3. Renovate will look up the latest version on [nuget.org](https://nuget.org) (or on [alternate feeds](#Alternate%20feeds)) to determine if any upgrades are available
4. 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 will be embedded in the generated PR
1. Renovate searches in each repository for any files with a `.csproj`, `.fsproj`, or `.vbproj` extension
1. Existing dependencies are extracted from `<PackageReference>` and `<PackageVersion>` tags
1. Renovate looks up the latest version on [nuget.org](https://nuget.org) (or on [alternate feeds](#Alternate%20feeds)) to determine if any upgrades are available
1. 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
## Alternate feeds
......@@ -39,15 +39,15 @@ Alternative feeds can be specified either [in a `NuGet.config` file](https://doc
}
```
If this example we defined 3 NuGet feeds.
Packages resolving will process feeds consequentially.
It means that if package will be resolved in second feed renovate won't look in last one.
In this example we defined 3 NuGet feeds.
Package resolving processes feeds in the listed order, from top to bottom.
This means that if a package is resolved in the second feed, Renovate won't check the third and final feed.
### Protocol versions
NuGet supports two protocol versions, `v2` and `v3`, which NuGet client and server need to agree on.
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 `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:
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:
```json
"nuget": {
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment