Skip to content

Commit 734d4ba

Browse files
authored
Update README to cover multiple effective severities (#1)
As a follow up from dotnet/roslyn#76004 adding an FAQ section for multiple effective severities.
1 parent d041086 commit 734d4ba

File tree

1 file changed

+21
-9
lines changed

1 file changed

+21
-9
lines changed

README.md

Lines changed: 21 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -253,15 +253,6 @@ Upload your SARIF reports as pipeline artifacts to help narrow down issues.
253253
artifact: 'sarif'
254254
```
255255

256-
### Common sources of baseline mismatches
257-
258-
- Different MSBuild parameters locally vs CI
259-
- Also check if settings are based off the `$(ContinuousIntegrationBuild)` property, which some CI providers set
260-
- Different SDK versions
261-
- Use a [global.json](https://learn.microsoft.com/en-us/dotnet/core/tools/global-json) to set the same SDK version
262-
locally and in CI
263-
- New SDK feature versions can introduce new analyzers so we suggest limiting `rollForward` to patch updates, or disable entirely
264-
265256
## Advanced configuration
266257

267258
### Set the SARIF output path
@@ -339,3 +330,24 @@ And then run `git add --renormalize .` to update Git with the re-normalized file
339330

340331
_Icon 'fractal' by Bohdan Burmich from [Noun Project](https://thenounproject.com/browse/icons/term/fractal/)
341332
(CC BY 3.0)_
333+
334+
## Frequently Asked Questions (FAQ)
335+
336+
### I'm getting a baseline mismatch I don't understand
337+
338+
This means that somehow you're building differently locally than you are in CI. Common causes are:
339+
340+
- Different MSBuild parameters locally vs CI
341+
- Also check if settings are based off the `$(ContinuousIntegrationBuild)` property, which some CI providers set
342+
- Different SDK versions
343+
- Use a [global.json](https://learn.microsoft.com/en-us/dotnet/core/tools/global-json) to set the same SDK version
344+
locally and in CI
345+
- New SDK feature versions can introduce new analyzers so we suggest limiting `rollForward` to patch updates, or disable entirely
346+
347+
### I see multiple entries for EffectiveSeverities, but I only expect one
348+
349+
This is probably because you've set rules in an `.editorconfig`, so it only applies to files that match the section. Importantly,
350+
this is true even for the root .editorconfig, as projects can contain files from outside the repo / project root, and thus the
351+
compiler is correctly (albeit pedantically) reporting that the project _could_ have files where .editorconfig rules don't apply.
352+
353+
If you want modify an analyzer rule project-wide, use a `.globalconfig` file.

0 commit comments

Comments
 (0)