Add API compat instructions to libraries building README #113088
Conversation
There was a problem hiding this comment.
PR Overview
This pull request adds instructions to the README for handling API compatibility errors during the library build process. The key change is the inclusion of guidance on suppressing API compatibility errors by re-invoking the dotnet pack command with a special argument when expected breaking changes occur.
- Added documentation outlining the API compatibility error and suppression steps.
Reviewed Changes
| File | Description |
|---|---|
| docs/workflow/building/libraries/README.md | Documentation update to guide handling of API compatibility errors |
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Tip: If you use Visual Studio Code, you can request a review from Copilot before you push from the "Source Control" tab. Learn more
|
Tagging subscribers to this area: @dotnet/area-infrastructure-libraries |
| @@ -256,3 +256,7 @@ Same as for `dotnet build` or `dotnet publish`, you can specify the desired conf | |||
| ```cmd | |||
| dotnet.cmd pack src\libraries\System.Text.Json\src\ -c Release | |||
| ``` | |||
|
|
|||
| If changes to the library include any API incompatibilities, calling `dotnet pack` will result in API compatibility errors. | |||
There was a problem hiding this comment.
@ViktorHofer will this work for framework libraries like System.Runtime / System.Net.Http / etc? Do we need to cover that case separately?
There was a problem hiding this comment.
Non packable projects under src/libraries run APICompat as part of the dotnet build command. I think that needs to be documented separately.
No description provided.