GlobalAnalyzerConfig broke with potential ordering change in .net 9 and no documentation tells you how to fix it

[EdLichtman]

Describe the bug

If you have a Directory.Build.targets, and you import a .globalconfig file, it no longer works. It did before NET9

To Reproduce

GlobalAnalyzerConfigBug.zip

Unzip and try to build that.

Exceptions (if any)

None. I get no exceptions when building this. That right there is the problem. I should be told that TestClass fails to build "BugTarget" because it's using File-Scoped names when the globalconfig requires that it has Block config.

Further technical details

.NET SDK:
Version: 9.0.100
Commit: 59db016
Workload version: 9.0.100-manifests.c6f19616
MSBuild version: 17.12.7+5b8665660

Runtime Environment:
OS Name: Windows
OS Version: 10.0.17763
OS Platform: Windows
RID: win-x64
Base Path: C:\Program Files\dotnet\sdk\9.0.100\

.NET workloads installed:
[aspire]
Installation Source: VS 17.12.35514.174
Manifest Version: 8.2.2/8.0.100
Manifest Path: C:\Program Files\dotnet\sdk-manifests\8.0.100\microsoft.net.sdk.aspire\8.2.2\WorkloadManifest.json
Install Type: Msi

Configured to use loose manifests when installing new manifests.

Host:
Version: 9.0.0
Architecture: x64
Commit: 9d5a6a9aa4

.NET SDKs installed:
1.1.14 [C:\Program Files\dotnet\sdk]
6.0.408 [C:\Program Files\dotnet\sdk]
7.0.400 [C:\Program Files\dotnet\sdk]
9.0.100 [C:\Program Files\dotnet\sdk]

.NET runtimes installed:
Microsoft.AspNetCore.App 3.1.32 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 6.0.16 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 6.0.36 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 7.0.10 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 7.0.12 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 7.0.20 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 8.0.11 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.AspNetCore.App 9.0.0 [C:\Program Files\dotnet\shared\Microsoft.AspNetCore.App]
Microsoft.NETCore.App 1.0.16 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 1.1.13 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 3.1.32 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 6.0.1 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 6.0.16 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 6.0.36 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 7.0.10 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 7.0.12 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 7.0.20 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 8.0.11 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.NETCore.App 9.0.0 [C:\Program Files\dotnet\shared\Microsoft.NETCore.App]
Microsoft.WindowsDesktop.App 3.1.32 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 6.0.1 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 6.0.16 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 6.0.36 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 7.0.10 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 7.0.20 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 8.0.11 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]
Microsoft.WindowsDesktop.App 9.0.0 [C:\Program Files\dotnet\shared\Microsoft.WindowsDesktop.App]

Other architectures found:
x86 [C:\Program Files (x86)\dotnet]
registered at [HKLM\SOFTWARE\dotnet\Setup\InstalledVersions\x86\InstallLocation]

Environment variables:
Not set

global.json file:
Not found

Learn more:
https://aka.ms/dotnet/info

Download .NET:
https://aka.ms/dotnet/download

[dotnet-issue-labeler]

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

[dotnet-issue-labeler]

I couldn't figure out the best area label to add to this issue. If you have write-permissions please help me learn by adding exactly one area label.

[marcpopMSFT]

@arunchndr @jaredpar change in the analyzers or change on our side caused this?

[arunchndr]

Possible change in build sequence. As a workaround and to rule out another possibility, can we try explicitly referencing the global config in the project file, just so we know there isn't definition conflict issue?

<ItemGroup>
  <AdditionalFiles Include="path\to\.globalconfig" />
</ItemGroup>

@EdLichtman fyi.

[arunchndr]

I dont have a repro for this on 9.0.100 btw. I get the BugTarget and TestClass failures while building. On a mac myself.

@EdLichtman https://github.com/jaredpar/complog?tab=readme-ov-file#creating-compiler-logs would be helpful.

[EdLichtman]

Oh I missed these followups! I'll produce an example probably Monday or Tuesday. I was able to do a workaround temporarily. I don't recall how but I'll add that workaround next week too. At least one workaround was manually adding <EditorConfigFiles> I think but I poured against that because it felt like the contract could change at any given time since that's an item group that's undocumented

…

On Tue, Dec 10, 2024, 6:03 PM Arun Chander ***@***.***> wrote: I dont have a repro for this on 9.0.100 btw. I get the BugTarget and TestClass failures while building. On a mac myself. @EdLichtman <https://github.com/EdLichtman> https://github.com/jaredpar/complog?tab=readme-ov-file#creating-compiler-logs would be helpful. — Reply to this email directly, view it on GitHub <#45150 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ADJXJMIQQOZILVFGR2QOVID2E56OLAVCNFSM6AAAAABSQ3KU5GVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKMZTGI3DGOBXGM> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[EdLichtman]

Oh, now I remember the workaround!

Basically, I just made sure that I imported it in the Directory.Build.props. An easy fix for sure, so there is no issue there.

The problem is however, I didn't know that it broke, or why it broke.

Also, I think you may be unable to reproduce because I think I accidentally provided an zip that wasn't exactly correct. I've modified it and added a binlog for you to observe:

Sample.zip

You'll notice I import the props in the targets file:

You'll also notice that the GenerateDocumentationFile is set to true in the props that's being propagated to the targets file:

You'll then see that I added GenerateDocumentationFile to the BugTarget.csproj:

This is because, even though I am importing the Props via the Targets file, I get a build error telling me that it's missing:

Then, you'll see that I require file_scoped:

And that I have file_scoped

But I get an error because I'm supposed to use block_scoped: