dotnet / dotnet/docs

Document baseline validation "strict mode"

Open
#38,551 0 comments 0 reactions 1 assignee Claimed by @gewarren View on GitHub
:watch: Not Triaged
Dominant language
No language data
Stars
4.8k
Forks
6.1k
Avg merge
19h 10m
Merged PRs (30d)
268

Description

Baseline package validation now also has a strict mode which we should probably document (similar to the other package validator documents): `EnableStrictModeForBaselineValidation`.

You want to set this to true when you want the apicompat to perform "equality" checks instead of compatibility checks. This means that api additions or changing the assembly (in a compatible way) is disallowed. The primary use-case for this is servicing in which API additions are usually forbidden.

You could also enable this so that APICompat records all compatibility differences in the suppression file (for tracking API changes). For that you would also need to set `ApiCompatGenerateSuppressionFile` to true.

_Originally posted by @ViktorHofer in https://github.com/dotnet/docs/pull/38533#discussion_r1412026574_

---
[Associated WorkItem - 189677](https://dev.azure.com/msft-skilling/Content/_workitems/edit/189677)

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.