CompatibilitySuppressions.xml file format is not fully documented #36988
Description
The article describes the basic structure of the CompatibilitySuppressions.xml file but leaves out a lot of interesting details.
Since there is no tooling or IDE integration for this, it must be read and understood manually to assess the breaking changes made in a PR or in an upcoming release.
For example:
- The rules itself are not documented (similar to https://learn.microsoft.com/dotnet/fundamentals/code-analysis/quality-rules). It is not even clear what rules exist.
- Depending on the rule,
<Target>,<Left>,<Right>may contain different types of content or the element can be omitted altogether (e.g. PKV0001 vs. CP1002 vs. CP0002). How must valid content look like?
Just a side note: That file might not really be review-friendly for humans because it is a bit hard to parse and the file format is not fully documented.
Originally posted by @bitbonk in #36954 (comment)
Document Details
⚠ Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.
- ID: 1076d3b1-dc45-1cc3-5961-8e369a9db793
- Version Independent ID: aec40896-e18d-a61d-2dbb-467556b24678
- Content: .NET Package Validation - .NET
- Content Source: docs/fundamentals/package-validation/overview.md
- Product: dotnet-fundamentals
- GitHub Login: @dotnet-bot
- Microsoft Alias: dotnetcontent