Build failure in sdk:

   GenerateDocumentationAndConfigFiles -> /__w/1/s/src/sdk/artifacts/bin/GenerateDocumentationAndConfigFiles/Release/net10.0/GenerateDocumentationAndConfigFiles.dll
    One or more auto-generated documentation files were either edited manually, or not updated. Please revert changes made to the following files (if manually edited) and run `msbuild /t:pack` at the root of the repo to automatically update them:
        /__w/1/s/src/sdk/src/Microsoft.CodeAnalysis.NetAnalyzers/src/Microsoft.CodeAnalysis.NetAnalyzers.sarif

This will likely fail again due to the added newline at the end of the sarif file. We should make this more robust.

This will likely fail again due to the added newline at the end of the sarif file. We should make this more robust.

This is a VScode thing I think...it's so ornery about this.

I meant that we should update the sarif diff to ignore empty lines at least at the end: https://github.com/dotnet/sdk/blob/e0c4dda2e07d99203f83254b7ff5d117fb8e2220/src/Microsoft.CodeAnalysis.NetAnalyzers/tools/GenerateDocumentationAndConfigFiles/Program.cs#L1156

I meant that we should update the sarif diff to ignore empty lines at least at the end: https://github.com/dotnet/sdk/blob/e0c4dda2e07d99203f83254b7ff5d117fb8e2220/src/Microsoft.CodeAnalysis.NetAnalyzers/tools/GenerateDocumentationAndConfigFiles/Program.cs#L1156

We should update the sarif file to not need to be updated on every release: dotnet/sdk#52150 covers this.

vscode should respect .editorconfig here - adding a sarif-specific set of instructions to not add newlines may be all that we'd have to do.

We should update the sarif file to not need to be updated on every release: dotnet/sdk#52150 covers this.

Sure that's the right thing to do but someone from netanalyzers would need to take a look. The tool's code is quite complex and uses compiler APIs to do all sorts of things. It needs a rewrite - it should be an msbuild task and must not use live dependencies as it is invoked during the build. It was one of the components that made the TFM retargeting harder. The same tool with the same codebase exists in roslyn as well.

An intermediate step to reduce the pain here would be to just ignore whitespaces in that comparison - or as chat mentioned updating the editorconfig setting for sarif files.

Workaorund here dotnet/sdk#52618