[dotnet-format] Include the .NET Framework buildhost executable in the SDK.

[JoeRobich]

This is necessary for dotnet-format to load .NET Framework projects.

Fixes #43017

[Kielek]

Could you please ensure that the fix will be included also in next hotfix for .NET9 release?

[JoeRobich]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 4 pipeline(s).

[JoeRobich]

/backport to release/9.0.2xx

[github-actions]

Started backporting to release/9.0.2xx: https://github.com/dotnet/sdk/actions/runs/12175899687

[epenet]

Hi
I am targetting 8.0.x, and it looks like the release of 8.0.16 today has broken dotnet format.
It was working fine in 8.0.15

dotnet format whitespace  --verify-no-changes --verbosity diagnostic
========================== Starting Command Output ===========================
"C:\Windows\system32\cmd.exe" /D /E:ON /V:OFF /S /C "CALL "D:\a\_temp\0a0b64ad-06be-4bf5-a936-16ee200968a8.cmd""
  The dotnet runtime version is '8.0.16'.
  The dotnet CLI version is '8.0.409'.
  Using MSBuild.exe located in 'C:\hostedtoolcache\windows/dotnet\sdk\8.0.409\'.
  Formatting code files in workspace 'D:\a\1\s\xxx.sln'.
  Loading workspace.
Unhandled exception: System.Exception: The build host could not be found at 'C:\hostedtoolcache\windows\dotnet\sdk\8.0.409\DotnetTools\dotnet-format\BuildHost-net472\Microsoft.CodeAnalysis.Workspaces.MSBuild.BuildHost.exe'
   at Microsoft.CodeAnalysis.MSBuild.BuildHostProcessManager.AssertBuildHostExists(String buildHostPath)
   at Microsoft.CodeAnalysis.MSBuild.BuildHostProcessManager.GetDotNetFrameworkBuildHostPath()
   at Microsoft.CodeAnalysis.MSBuild.BuildHostProcessManager.CreateDotNetFrameworkBuildHostStartInfo()
   at Microsoft.CodeAnalysis.MSBuild.BuildHostProcessManager.GetBuildHostAsync(BuildHostProcessKind buildHostKind, CancellationToken cancellationToken)
   at Microsoft.CodeAnalysis.MSBuild.BuildHostProcessManager.GetBuildHostWithFallbackAsync(BuildHostProcessKind buildHostKind, String projectOrSolutionFilePath, CancellationToken cancellationToken)
   at Microsoft.CodeAnalysis.MSBuild.MSBuildProjectLoader.Worker.LoadProjectFileInfosAsync(String projectPath, DiagnosticReportingOptions reportingOptions, CancellationToken cancellationToken)
   at Microsoft.CodeAnalysis.MSBuild.MSBuildProjectLoader.Worker.LoadProjectInfosFromPathAsync(String projectPath, DiagnosticReportingOptions reportingOptions, CancellationToken cancellationToken)
   at Microsoft.CodeAnalysis.MSBuild.MSBuildProjectLoader.Worker.LoadAsync(CancellationToken cancellationToken)
   at Microsoft.CodeAnalysis.MSBuild.MSBuildProjectLoader.LoadSolutionInfoAsync(String solutionFilePath, IProgress`1 progress, ILogger msbuildLogger, CancellationToken cancellationToken)
   at Microsoft.CodeAnalysis.MSBuild.MSBuildProjectLoader.LoadSolutionInfoAsync(String solutionFilePath, IProgress`1 progress, ILogger msbuildLogger, CancellationToken cancellationToken)
   at Microsoft.CodeAnalysis.MSBuild.MSBuildWorkspace.OpenSolutionAsync(String solutionFilePath, ILogger msbuildLogger, IProgress`1 progress, CancellationToken cancellationToken)
   at Microsoft.CodeAnalysis.Tools.Workspaces.MSBuildWorkspaceLoader.LoadAsync(String solutionOrProjectPath, WorkspaceType workspaceType, String binaryLogPath, Boolean logWorkspaceWarnings, ILogger logger, CancellationToken cancellationToken)
   at Microsoft.CodeAnalysis.Tools.CodeFormatter.OpenMSBuildWorkspaceAsync(String solutionOrProjectPath, WorkspaceType workspaceType, Boolean noRestore, Boolean requiresSemantics, String binaryLogPath, Boolean logWorkspaceWarnings, ILogger logger, CancellationToken cancellationToken)
   at Microsoft.CodeAnalysis.Tools.CodeFormatter.FormatWorkspaceAsync(FormatOptions formatOptions, ILogger logger, CancellationToken cancellationToken, String binaryLogPath)
   at Microsoft.CodeAnalysis.Tools.FormatCommandCommon.FormatAsync(FormatOptions formatOptions, ILogger`1 logger, CancellationToken cancellationToken)
   at Microsoft.CodeAnalysis.Tools.Commands.FormatWhitespaceCommand.FormatWhitespaceHandler.InvokeAsync(ParseResult parseResult, CancellationToken cancellationToken)
   at System.CommandLine.Invocation.InvocationPipeline.InvokeAsync(ParseResult parseResult, CancellationToken cancellationToken)

[JoeRobich]

/backport to release/8.0.4xx

[github-actions]

Started backporting to release/8.0.4xx: https://github.com/dotnet/sdk/actions/runs/15032948879

[github-actions]

@JoeRobich backporting to "release/8.0.4xx" failed, the patch most likely resulted in conflicts:

$ git am --3way --empty=keep --ignore-whitespace --keep-non-patch changes.patch

Applying: Include the .NET Framework buildhost executable in the SDK.
Using index info to reconstruct a base tree...
M	src/Layout/redist/targets/GenerateLayout.targets
Falling back to patching base and 3-way merge...
Auto-merging src/Layout/redist/targets/GenerateLayout.targets
CONFLICT (content): Merge conflict in src/Layout/redist/targets/GenerateLayout.targets
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config set advice.mergeConflict false"
Patch failed at 0001 Include the .NET Framework buildhost executable in the SDK.
Error: The process '/usr/bin/git' failed with exit code 128

Please backport manually!

[JoeRobich]

@epenet I opened a backport at #48969. Will see if it meets the servicing bar.

[arunchndr]

@marcpopMSFT fyi. We would like to bring this for approval in next tactics.

[marcpopMSFT]

@arunchndr please fill out the template in 48969 and send mail to the tactics alias tomorrow. They want to start building for June before the next tactics meeting. There might be rebuilds next week but they start early to get testing going early.

BTW, we support the /backport command in this repo so ya'll can use that next time you backport if you like.