Skip to content

Update doc about global.json to include new properties for SDK resolution #45614

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 3, 2025
Merged

Update doc about global.json to include new properties for SDK resolution #45614

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7096af0
Update doc about global.json to include new properties for SDK resolu…
elinor-fung Apr 2, 2025
7c8a635
Update docs/core/tools/global-json.md
elinor-fung Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/core/tools/global-json.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,22 @@ The following table shows the possible values for the `rollForward` key:
| `latestMajor` | Uses the highest installed .NET SDK with a version that's greater than or equal to the specified value. <br> If not found, fail. |
| `disable` | Doesn't roll forward. An exact match is required. |

#### paths

- Type: Array of `string`
- Available since: .NET 10 Preview 3 SDK.

Specifies additional locations that should be considered when searching for a compatible .NET SDK. Paths can be absolute or relative to the location of the *global.json* file. The special value `$host$` represents the location corresponding to the running `dotnet` executable.

These paths are searched in the order they're defined and the first [matching](#matching-rules) SDK is used.

#### errorMessage

- Type: `string`
- Available since: .NET 10 Preview 3 SDK.

Specifies a custom error message displayed when the SDK resolver can't find a compatible .NET SDK.

### msbuild-sdks

Type: `object`
Expand Down Expand Up @@ -163,6 +179,18 @@ The following example shows how to use the highest patch version installed of a
}
```

The following example shows how to specify additional SDK search paths and a custom error message:

```json
{
"sdk": {
"version": "10.0.100",
"paths": [ ".dotnet", "$host$" ],
"errorMessage": "The required .NET SDK wasn't found. Please run ./install.sh to install it."
}
}
```

## global.json and the .NET CLI

To set an SDK version in the *global.json* file, it's helpful to know which SDK versions are installed on your machine. For information on how to do that, see [How to check that .NET is already installed](../install/how-to-detect-installed-versions.md#check-sdk-versions).
Expand Down