Skip to content

Update DEVGUIDE.md and dev container for non-released SDK usage #18716

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

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from
Draft

Update DEVGUIDE.md and dev container for non-released SDK usage #18716

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0d8dc8c
Initial plan
Copilot Jun 25, 2025
019f991
Add documentation and dev container setup for non-released SDK usage
Copilot Jun 25, 2025
7a9c995
Fix JSON syntax in devcontainer.json and validate configuration
Copilot Jun 25, 2025
f1b67a8
Move environment variables to remoteEnv and simplify postCreateCommand
Copilot Jun 25, 2025
79f6692
Clarify SDK setup documentation: separate one-time installation from …
Copilot Jun 25, 2025
6fc4c1c
Remove unnecessary explanation section from DEVGUIDE.md
Copilot Jun 25, 2025
2a682b7
Remove problematic DOTNET_ROOT and PATH variables from devcontainer
Copilot Jun 26, 2025
7bf9997
Revert "Remove problematic DOTNET_ROOT and PATH variables from dev co…
Copilot Jun 26, 2025
1484592
Update PATH environment variable to use containerEnv:PATH syntax
Copilot Jun 26, 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
9 changes: 7 additions & 2 deletions .devcontainer/devcontainer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,12 @@
}
},
"remoteEnv": {
"TARGET": "net9.0"
"TARGET": "net9.0",
"DOTNET_ROOT": "${containerWorkspaceFolder}/.dotnet",
"PATH": "${containerWorkspaceFolder}/.dotnet:${PATH}"
},
"postCreateCommand": [ "dotnet", "build", "FSharp.Compiler.Service.sln"]
"postCreateCommand": [
"bash", "-c",
"./eng/common/dotnet.sh && dotnet build FSharp.Compiler.Service.sln"
]
}
56 changes: 56 additions & 0 deletions DEVGUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,62 @@ Running tests:

You can then open `FSharp.sln` in your editor of choice.

## Working with non-released .NET SDKs

This repository may require a non-released version of the .NET SDK, as specified in the `global.json` file. When the required SDK version is not publicly available through normal channels, you may encounter an error when running `dotnet build` directly:

```
The .NET SDK could not be found, please run ./eng/common/dotnet.sh.
```

### Setting up the correct SDK

Before using plain `dotnet build` commands, you need to install the required SDK version locally:

**On Linux/macOS:**
```shell
./eng/common/dotnet.sh
```

**On Windows:**
```shell
.\eng\common\dotnet.cmd
```

This downloads and installs the correct SDK version to a local `.dotnet` directory in the repository root.

### Using dotnet commands with the local SDK

After running the setup script, you can use `dotnet` commands in two ways:

1. **Use the wrapper scripts** (recommended):
```shell
# Linux/macOS
./eng/common/dotnet.sh build FSharp.Compiler.Service.sln
./eng/common/dotnet.sh test tests/FSharp.Compiler.Service.Tests/

# Windows
.\eng\common\dotnet.cmd build FSharp.Compiler.Service.sln
.\eng\common\dotnet.cmd test tests\FSharp.Compiler.Service.Tests\
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot These should be separated into installing missing SDK via a one-time run of dotnet.sh and then use dotnet build FSharp.Compiler.Service normally, since dotnet can now locate needed SDK itself via global.json.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've updated the documentation to clarify the two-step process: run ./eng/common/dotnet.sh once to install the SDK, then use regular dotnet build commands since dotnet can locate the SDK via global.json. The documentation now emphasizes the one-time installation step followed by normal dotnet usage. (2e89d94)

```

2. **Set environment variables** to use plain `dotnet` commands:
```shell
# Linux/macOS
export DOTNET_ROOT=$(pwd)/.dotnet
export PATH="$DOTNET_ROOT:$PATH"
dotnet build FSharp.Compiler.Service.sln

# Windows (PowerShell)
$env:DOTNET_ROOT = "$(Get-Location)\.dotnet"
$env:PATH = "$env:DOTNET_ROOT;$env:PATH"
dotnet build FSharp.Compiler.Service.sln
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This whole section is not really needed, since latest versions of the dotnet can figure out the paths from the global.json themselves.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the unnecessary explanatory section since modern dotnet versions handle global.json automatically. (6fc4c1c)


### Why this is needed

The `global.json` file in this repository pins to a specific SDK version that may be a preview or internal build not yet publicly released. The Arcade build system (used by .NET repositories) automatically downloads and uses the correct SDK version, but plain `dotnet` commands need to be pointed to this local installation.

## Testing from the command line

You can find all test options as separate flags. For example `build -testAll`:
Expand Down
Loading