Enable Source Link in design-time build

[tmat]

Source Link, which is now included in the SDK and enabled by default, is causing Hot Reload to block stepping. Depending on timing of design-time builds this intermittently prevents the customer from debugging their application. Hot Reload blocks stepping due to differences in generated AssemlyInfo.cs files caused by Source Link targets.

Git commit SHA that is now included in AssemblyInformationalVersion attribute by default was not set in design-time build. This caused the content of *.AssemlyInfo.cs to differ between regular build and design-time build. If design-time build run after the debugging has started Hot Reload registered this difference as a change to be applied. Changing assembly level attributes is currently a rude edit and thus the change application is blocked, which in turns blocks stepping.

Fixes dotnet/sdk#36666

Customer Impact

Debugging projects is broken.

A workaround is to set EnableSourceControlManagerQueries to true globally (for all projects in the repo), e.g. add Directory.Build.props to the source root with:

<Project>
  <PropertyGroup>
    <EnableSourceControlManagerQueries>true</EnableSourceControlManagerQueries>
  </PropertyGroup>
</Project>

Regression?

• Yes
• No

7.0

Risk

• High
• Medium
• Low

The change sets property that enables the same code path that's already executed in regular build to run in design-time build.

Verification

• Manual (required)
• Automated

Packaging changes reviewed?

• Yes
• No
• N/A

[rainersigwald]

The change looks fine to me but has implications for partner teams that I'd want signoff from.

[tmeschter]

In general the set of compiler inputs and their contents should be the same in design-time builds and real builds. When we need to turn something off for DTBs we need to think hard about how that is going to impact the IDE. My advice is don't disable things in the DTB until you know they are expensive.

[tmat]

In general the set of compiler inputs and their contents should be the same in design-time builds and real builds. When we need to turn something off for DTBs we need to think hard about how that is going to impact the IDE. My advice is don't disable things in the DTB until you know they are expensive.

Agreed, in general, but I think we can safely exclude command line switches that only affect emit and do not affect EnC.

[tmeschter]

Agreed, in general, but I think we can safely exclude command line switches that only affect emit and do not affect EnC.

Sounds good to me.

[tmat]

Fixed in 8.0.200-preview.23604.9