Skip to content
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

Update DEVGUIDE.md #16197

Merged
merged 1 commit into from
Aug 12, 2024
Merged

Update DEVGUIDE.md #16197

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions DEVGUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,17 @@ or
> **Note**
> Please note, that by default, **Release** version of IL baseline tests will be running in CI, so when updating baseline (.bsl) files, make sure to add `-c Release` flag to the build command.


### Updating FCS surface area baselines

```bash
$env:TEST_UPDATE_BSL=1
Copy link
Member

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).

Copy link
Contributor

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

Copy link
Member

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.

Copy link
Member

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:

4c60c63

dotnet test tests/FSharp.Compiler.Service.Tests/FSharp.Compiler.Service.Tests.fsproj --filter "SurfaceAreaTest" /p:BUILDING_USING_DOTNET=true
Copy link
Member

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" /p:BUILDING_USING_DOTNET=true
abonie marked this conversation as resolved.
Show resolved Hide resolved
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
Comment on lines +206 to +207
Copy link
Member

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?

Copy link
Contributor Author

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.

Copy link
Member

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.

```

## Automated Source Code Formatting

Some of the code in this repository is formatted automatically by [Fantomas](https://github.com/fsprojects/fantomas). To format all files use:
Expand Down