-
Notifications
You must be signed in to change notification settings - Fork 789
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.
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
Update DEVGUIDE.md #16197
Update DEVGUIDE.md #16197
Conversation
### Updating FCS surface area baselines | ||
|
||
```bash | ||
$env:TEST_UPDATE_BSL=1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not needed for surface area, only test baselines (unless something changed lately, and if it does, it needs to be reverted to not require that flag).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You sure?
fsharp/tests/FSharp.Compiler.Service.Tests/SurfaceArea.fs
Lines 9 to 18 in 4c60c63
type SurfaceAreaTest() = | |
// This relies on a set of baselines to update the baseline set an environment variable before running the tests, then on failure the baselines will be updated | |
// Handled by SurfaceArea.verify | |
// | |
// CMD: | |
// set TEST_UPDATE_BSL=1 | |
// PowerShell: | |
// $env:TEST_UPDATE_BSL=1 | |
// Linux/macOS: | |
// export TEST_UPDATE_BSL=1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It used to not rely. That was the whole point of it, so when you run tests, you update it and it was part of PR and reflected there.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It was always updating it, I am not sure why would we make it not to:
|
||
```bash | ||
$env:TEST_UPDATE_BSL=1 | ||
dotnet test tests/FSharp.Compiler.Service.Tests/FSharp.Compiler.Service.Tests.fsproj --filter "SurfaceAreaTest" /p:BUILDING_USING_DOTNET=true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This won't work if building with build scripts. The dotnet building flag is not officially supported with arcade builds, and will yield cryptic errors.
This should instead explain how to update surface area with build scripts and separately with dotnet test, same as it is done with builds.
dotnet test tests/FSharp.Compiler.Service.Tests/FSharp.Compiler.Service.Tests.fsproj --filter "SurfaceAreaTest" -c Release /p:BUILDING_USING_DOTNET=true | ||
dotnet test tests/FSharp.Compiler.Service.Tests/FSharp.Compiler.Service.Tests.fsproj --filter "SurfaceAreaTest" -c Release /p:BUILDING_USING_DOTNET=true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is it here twice?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
First pass, the test will fail (and update the baseline), second pass, it is green.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But second isn't necessarily needed probably, should mention that and say that second one is optional.
Add a section about updating FCS surface area baselines specifically.
Credit to @auduchinok