Implement roll-forward policies for .NET Core SDK resolution. #6953

peterhuene · 2019-06-27T02:22:18Z

This PR implements additional roll-forward policies for resolving a .NET
Core SDK based upon new SDK settings in global.json.

Two new values are now supported in global.json in the sdk settings:

rollForward - the roll-forward policy to use (see below).
allowPrerelease - controls whether or not preview SDKS may be resolved
(defaults to true to allow resolving prerelease SDKs).

The new roll-forward policies are:

patch - If the requested SDK is installed, use it. Otherwise, use the
latest installed patch level that matches the requested major, minor, and
feature band.
feature - If the requested major, minor, and feature band is installed, use
the latest patch level for the specified feature band. Otherwise, roll-forward
to the next available feature band and use the latest patch level for that
feature band.
minor - If the requested major, minor, and feature band is installed, use
the latest patch level for the specified feature band. Otherwise, roll-forward
to the next available feature band available for the same major version and use
the latest patch level for that feature band.
major - If the requested major, minor, and feature band is installed, use
the latest patch level for the specified feature band. Otherwise, roll-forward
to the next available feature band available without restriction and use the
latest patch level for that feature band.
latestPatch - Use the latest installed patch level that matches the
requested major, minor, and feature band.
latestFeature - Use the latest installed patch level for the latest
installed feature band that matches the requested major and minor version.
latestMinor - Use the latest installed patch level for the latest installed
feature band for the latest installed minor version that matches the requested
major version.
latestMajor - Use the absolutely latest .NET Core SDK available.

For backwards compatibility, the policy when a version is not specified in
global.json will be latestMajor. The default policy when a version is
specified but rollForward is not specified will be patch.

peterhuene · 2019-06-27T02:23:04Z

See design document for more information on this feature.

This commit implements additional roll-forward policies for resolving a .NET Core SDK based upon new SDK settings in `global.json`. Two new values are now supported in `global.json` in the `sdk` settings: * `rollForward` - the roll-forward policy to use (see below). * `allowPrerelease` - controls whether or not preview SDKS may be resolved. The new roll-forward policies are: * `patch` - If the requested SDK is installed, use it. Otherwise, use the latest installed patch level that matches the requested major, minor, and feature band. * `feature` - If the requested major, minor, and feature band is installed, use the latest patch level for the specified feature band. Otherwise, roll-forward to the next available feature band and use the latest patch level for that feature band. * `minor` - If the requested major, minor, and feature band is installed, use the latest patch level for the specified feature band. Otherwise, roll-forward to the next available feature band available for the same major version and use the latest patch level for that feature band. * `major` - If the requested major, minor, and feature band is installed, use the latest patch level for the specified feature band. Otherwise, roll-forward to the next available feature band available without restriction and use the latest patch level for that feature band. * `latestPatch` - Use the latest installed patch level that matches the requested major, minor, and feature band. * `latestFeature` - Use the latest installed patch level for the latest installed feature band that matches the requested major and minor version. * `latestMinor` - Use the latest installed patch level for the latest installed feature band for the latest installed minor version that matches the requested major version. * `latestMajor` - Use the absolutely latest .NET Core SDK available. For backwards compatibility, the policy when a `version` is not specified in `global.json` will be `latestMajor`. The default policy when a `version` is specified but `rollForward` is not specified will be `patch`.

nguerrera · 2019-06-27T15:17:55Z

The default policy when a version is
specified but rollForward is not specified will be patch.

I thought we agreed to change this to major.

peterhuene · 2019-06-27T15:26:56Z

I wasn't sure if that was now captured in the design document, but you're right. It's easy to change and update the tests. I'll push that up and we can fix any language needed in the doc.

peterhuene · 2019-06-27T17:34:24Z

We're going to discuss changing the default when just a version is specified from patch to major later today, as Kathleen has raised some concerns. If we do decide to change the default, I'll push up that change at that time. Until then, this can be reviewed with no change in the existing behavior.

src/corehost/cli/fxr/fx_muxer.cpp

src/corehost/cli/fxr/sdk_resolver.cpp

src/corehost/cli/fxr/sdk_resolver.h

src/corehost/cli/fxr/sdk_resolver.cpp

src/corehost/cli/fxr/sdk_resolver.h

src/corehost/cli/fxr/sdk_resolver.cpp

src/test/HostActivationTests/SDKLookup.cs

peterhuene · 2019-06-27T22:41:40Z

We've decided not to change the default behavior when a version is specified without rollForward policy in global.json. The default will remain as patch for now. Thus, these changes should not introduce any breaking changes for now.

This commit makes the policy names for the `sdk/rollForward` value in `global.json` case insensitive. It also removes the switch statements used in parsing / displaying the roll forward policy names in favor of a constant array of names indexed by the enum value.

* Removed unused members from `sdk_resolver`. * Remove unnecessary logging relating to BOMs. * Change to warnings instead of errors when failing to parse global.json (we fallback to "use latest" behavior). * Use JSON names in logging for values read in from global.json. * Remove underscore prefix from member variables. * Make `matches_policy` and `is_better_match` less redundant in the checks performed. * Rename `exact_match_allowed` to `exact_match_preferred`. * Fix whitespace in test.

This commit "theorizes" the invalid global.json test to eliminate duplicated code.

nguerrera

vitek-karas

assuming we have all the right approvals - even though in theory this should not be a breaking change, it's large enough to be treated similarly (especially since our test coverage is somewhat sparse and so it's hard to prove with reasonable confidence that this won't break anything).

This commit turns the JSON parsing failure back to an error for backwards compatibility. The new diagnostic messages remain as warnings.

livarcocc · 2019-07-10T00:22:08Z

This has been approved by Steve already. I gave him a heads up on this change a few weeks ago. Feel free to merge.

Also, just noticed the comment does not say what is the default for allowPrerelease. Should we state that in the description for the PR?

peterhuene · 2019-07-10T00:23:34Z

I'll update the PR description to include that information.

peterhuene · 2019-07-10T00:30:32Z

Oh right, I don't have access to merge 😄.

See dotnet/core-setup#6953

TheXenocide · 2020-04-29T19:36:21Z

Is it possible to use these settings on items in the msbuild-sdks section? With NuGet we would use wildcard versions, but it doesn't seem to accept anything of the sort

…/core-setup#6953) Implements additional roll-forward policies for resolving a .NET Core SDK based upon new SDK settings in `global.json`. Two new values are now supported in `global.json` in the `sdk` settings: * `rollForward` - the roll-forward policy to use (see below). * `allowPrerelease` - controls whether or not preview SDKS may be resolved (defaults to `true` to allow resolving prerelease SDKs). The new roll-forward policies are: * `patch` - If the requested SDK is installed, use it. Otherwise, use the latest installed patch level that matches the requested major, minor, and feature band. * `feature` - If the requested major, minor, and feature band is installed, use the latest patch level for the specified feature band. Otherwise, roll-forward to the next available feature band and use the latest patch level for that feature band. * `minor` - If the requested major, minor, and feature band is installed, use the latest patch level for the specified feature band. Otherwise, roll-forward to the next available feature band available for the same major version and use the latest patch level for that feature band. * `major` - If the requested major, minor, and feature band is installed, use the latest patch level for the specified feature band. Otherwise, roll-forward to the next available feature band available without restriction and use the latest patch level for that feature band. * `latestPatch` - Use the latest installed patch level that matches the requested major, minor, and feature band. * `latestFeature` - Use the latest installed patch level for the latest installed feature band that matches the requested major and minor version. * `latestMinor` - Use the latest installed patch level for the latest installed feature band for the latest installed minor version that matches the requested major version. * `latestMajor` - Use the absolutely latest .NET Core SDK available. For backwards compatibility, the policy when a `version` is not specified in `global.json` will be `latestMajor`. The default policy when a `version` is specified but `rollForward` is not specified will be `patch`. Commit migrated from dotnet/core-setup@5cd0245

peterhuene force-pushed the global-json-sdk-improvements branch from 3a97deb to 763475d Compare June 27, 2019 02:58

nguerrera requested review from vitek-karas, nguerrera, johnbeisner and livarcocc June 27, 2019 16:02

johnbeisner reviewed Jun 27, 2019

View reviewed changes

src/corehost/cli/fxr/fx_muxer.cpp Show resolved Hide resolved

peterhuene commented Jun 27, 2019

View reviewed changes

src/corehost/cli/fxr/sdk_resolver.cpp Show resolved Hide resolved

vitek-karas reviewed Jun 27, 2019

View reviewed changes

peterhuene force-pushed the global-json-sdk-improvements branch from b603438 to 4ec4e34 Compare June 29, 2019 09:24

peterhuene force-pushed the global-json-sdk-improvements branch 2 times, most recently from 28590b5 to 79ba75f Compare June 30, 2019 02:34

Peter Huene added 2 commits June 30, 2019 22:25

Theorize invalid global.json test.

af1b5ec

This commit "theorizes" the invalid global.json test to eliminate duplicated code.

peterhuene force-pushed the global-json-sdk-improvements branch from 79ba75f to af1b5ec Compare July 1, 2019 05:25

nguerrera mentioned this pull request Jul 3, 2019

Update .NET Core SDK Url in build on Windows instructions dotnet/roslyn#36939

Merged

nguerrera approved these changes Jul 3, 2019

View reviewed changes

vitek-karas approved these changes Jul 6, 2019

View reviewed changes

Keep JSON parse failure an error.

a614add

This commit turns the JSON parsing failure back to an error for backwards compatibility. The new diagnostic messages remain as warnings.

vitek-karas merged commit 5cd0245 into dotnet:master Jul 10, 2019

ViktorHofer mentioned this pull request Jul 12, 2019

Add sdk roll.forward policy in global.json dotnet/corefx#39428

Merged

bruno-garcia added a commit to bruno-garcia/Bazinga.AspNetCore.Authentication.Basic that referenced this pull request Aug 15, 2019

Latest SDK prewiew with new rollforward

33a3144

See dotnet/core-setup#6953

peterhuene deleted the global-json-sdk-improvements branch September 15, 2019 19:35

slang25 mentioned this pull request Sep 15, 2019

Implement upcoming global.json rollforward feature josephwoodward/DotNetInstallSdkGlobalTool#12

Open

dagood mentioned this pull request Sep 18, 2019

Incorrect SDK version used when multiple SDKs are installed dotnet/arcade#3764

Open

jnm2 mentioned this pull request Sep 30, 2019

Update global.json schema to match .NET Core SDK 3.0 release SchemaStore/schemastore#807

Merged

ericstj mentioned this pull request Nov 22, 2019

coreclr build failure: Unable to find package Microsoft.AspNetCore.App.Runtime.win-arm dotnet/runtime#185

Closed

vitek-karas mentioned this pull request Mar 9, 2020

Major-version roll-forward options for Core 3.0 dotnet/docs#12237

Closed

TheXenocide mentioned this pull request Apr 29, 2020

Make global.json "sdk/version" support min/max, or wildcards dotnet/runtime#2541

Closed

asmichi mentioned this pull request Feb 14, 2025

Incorrect documentation on the default rollForward policy (when a version is specified) dotnet/docs#44897

Open

nileshsheth mentioned this pull request Feb 22, 2025

fix(docs): Correct default rollForward policy in global.json documentation dotnet/docs#44996

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Implement roll-forward policies for .NET Core SDK resolution. #6953

Implement roll-forward policies for .NET Core SDK resolution. #6953

peterhuene commented Jun 27, 2019 •

edited

Loading

peterhuene commented Jun 27, 2019

nguerrera commented Jun 27, 2019

peterhuene commented Jun 27, 2019

peterhuene commented Jun 27, 2019

peterhuene commented Jun 27, 2019

nguerrera left a comment

vitek-karas left a comment

livarcocc commented Jul 10, 2019

peterhuene commented Jul 10, 2019

peterhuene commented Jul 10, 2019

TheXenocide commented Apr 29, 2020

Implement roll-forward policies for .NET Core SDK resolution. #6953

Implement roll-forward policies for .NET Core SDK resolution. #6953

Conversation

peterhuene commented Jun 27, 2019 • edited Loading

peterhuene commented Jun 27, 2019

nguerrera commented Jun 27, 2019

peterhuene commented Jun 27, 2019

peterhuene commented Jun 27, 2019

peterhuene commented Jun 27, 2019

nguerrera left a comment

Choose a reason for hiding this comment

vitek-karas left a comment

Choose a reason for hiding this comment

livarcocc commented Jul 10, 2019

peterhuene commented Jul 10, 2019

peterhuene commented Jul 10, 2019

TheXenocide commented Apr 29, 2020

peterhuene commented Jun 27, 2019 •

edited

Loading