Merge the microbuild branch from https://github.com/aarnott/Library.Template

AArnott · AArnott · commit 5370ecd96311 · 2025-06-05T10:50:16.000-06:00
Specifically, this merges [ae78ccb from that repo](AArnott/Library.Template@ae78ccb).
diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json
@@ -3,7 +3,7 @@
   "isRoot": true,
   "tools": {
     "powershell": {
-      "version": "7.5.0",
+      "version": "7.5.1",
       "commands": [
         "pwsh"
       ],
diff --git a/.devcontainer/Dockerfile b/.devcontainer/Dockerfile
@@ -1,5 +1,5 @@
 # Refer to https://hub.docker.com/_/microsoft-dotnet-sdk for available versions
-FROM mcr.microsoft.com/dotnet/sdk:9.0.202-noble@sha256:332e0362dd210a10348d436a5fb7f87aeec28c2c53ac2c3c2659e57c22294d0e
+FROM mcr.microsoft.com/dotnet/sdk:9.0.300-noble@sha256:9f7bd4d010026e15a57d9cf876f2f7d08c3eeed6a0ea987b8c5ba8c75e68e948
 
 # Installing mono makes `dotnet test` work without errors even for net472.
 # But installing it takes a long time, so it's excluded by default.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -82,3 +82,17 @@ Configuration is in the `.github/renovate.json` file.
 When changing the renovate.json file, follow [these validation steps](https://docs.renovatebot.com/config-validation/).
 
 If Renovate is not creating pull requests when you expect it to, check that the [Renovate GitHub App](https://github.com/apps/renovate) is configured for your account or repo.
+
+## Merging latest from Library.Template
+
+### Maintaining your repo based on this template
+
+The best way to keep your repo in sync with Library.Template's evolving features and best practices is to periodically merge the template into your repo:
+`
+```ps1
+git fetch
+git checkout origin/main
+.\tools\MergeFrom-Template.ps1
+# resolve any conflicts, then commit the merge commit.
+git push origin -u HEAD
+```
diff --git a/Directory.Build.props b/Directory.Build.props
@@ -7,6 +7,7 @@
     <BaseOutputPath Condition=" '$(BaseOutputPath)' == '' ">$(RepoRootPath)bin\$(MSBuildProjectName)\</BaseOutputPath>
     <PackageOutputPath>$(RepoRootPath)bin\Packages\$(Configuration)\NuGet\</PackageOutputPath>
     <VSIXOutputPath>$(RepoRootPath)bin\Packages\$(Configuration)\Vsix\$(Platform)\</VSIXOutputPath>
+    <SBOMFileDestPath>$(VSIXOutputPath)</SBOMFileDestPath>
     <Nullable>enable</Nullable>
     <ImplicitUsings>enable</ImplicitUsings>
     <AnalysisLevel>latest</AnalysisLevel>
@@ -38,6 +39,11 @@
     <SymbolPackageFormat>snupkg</SymbolPackageFormat>
   </PropertyGroup>
 
+  <PropertyGroup>
+    <LangVersion Condition="'$(MSBuildProjectExtension)'=='.csproj'">13</LangVersion>
+    <LangVersion Condition="'$(MSBuildProjectExtension)'=='.vbproj'">16.9</LangVersion>
+  </PropertyGroup>
+
   <ItemGroup>
     <None Include="$(RepoRootPath)obj/NOTICE" Pack="true" PackagePath="" Visible="false" Condition=" Exists('$(RepoRootPath)obj/NOTICE') " />
   </ItemGroup>
@@ -56,4 +62,6 @@
       <PackageReleaseNotes Condition="'$(RepositoryUrl)'!=''">$(RepositoryUrl)/releases/tag/v$(Version)</PackageReleaseNotes>
     </PropertyGroup>
   </Target>
+
+  <Import Project="azure-pipelines\NuGetSbom.props" />
 </Project>
diff --git a/Directory.Build.targets b/Directory.Build.targets
@@ -1,9 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project>
-  <PropertyGroup>
-    <LangVersion Condition="'$(Language)'=='C#'">13</LangVersion>
-    <LangVersion Condition="'$(Language)'=='VB'">16.9</LangVersion>
-  </PropertyGroup>
   <ItemGroup>
     <!-- Avoid compile error about missing namespace when combining ImplicitUsings with .NET Framework target frameworks. -->
     <Using Remove="System.Net.Http" Condition="'$(TargetFrameworkIdentifier)'=='.NETFramework'" />
@@ -12,6 +8,4 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.CodeAnalysis.ResxSourceGenerator" PrivateAssets="all" />
   </ItemGroup>
-
-  <Import Project="azure-pipelines\NuGetSbom.targets" Condition="'$(IsPackable)'!='false'" />
 </Project>
diff --git a/Directory.Packages.props b/Directory.Packages.props
@@ -12,10 +12,10 @@
     <PackageVersion Include="Moq" Version="4.20.72" />
   </ItemGroup>
   <ItemGroup Label="Library.Template">
-    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
+    <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
     <PackageVersion Include="Microsoft.VisualStudio.Internal.MicroBuild.NonShipping" Version="$(MicroBuildVersion)" />
-    <PackageVersion Include="xunit.runner.visualstudio" Version="3.0.2" />
-    <PackageVersion Include="xunit.v3" Version="1.1.0" />
+    <PackageVersion Include="xunit.runner.visualstudio" Version="3.1.0" />
+    <PackageVersion Include="xunit.v3" Version="2.0.2" />
   </ItemGroup>
   <ItemGroup>
     <!-- Put repo-specific GlobalPackageReference items in this group. -->
@@ -24,7 +24,8 @@
     <GlobalPackageReference Include="CSharpIsNullAnalyzer" Version="0.1.593" />
     <GlobalPackageReference Include="DotNetAnalyzers.DocumentationAnalyzers" Version="1.0.0-beta.59" />
     <GlobalPackageReference Include="Microsoft.VisualStudio.Internal.MicroBuild.VisualStudio" Version="$(MicroBuildVersion)" />
-    <GlobalPackageReference Include="Nerdbank.GitVersioning" Version="3.7.115" />
+    <!-- The condition works around https://github.com/dotnet/sdk/issues/44951 -->
+    <GlobalPackageReference Include="Nerdbank.GitVersioning" Version="3.7.115" Condition="!('$(TF_BUILD)'=='true' and '$(dotnetformat)'=='true')" />
     <GlobalPackageReference Include="PolySharp" Version="1.15.0" />
     <GlobalPackageReference Include="StyleCop.Analyzers.Unstable" Version="1.2.0.556" />
   </ItemGroup>
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -0,0 +1,16 @@
+# Support
+
+## How to file issues and get help
+
+This project uses GitHub Issues to track bugs and feature requests.
+Please search the existing issues before filing new issues to avoid duplicates.
+For new issues, file your bug or feature request as a new Issue.
+
+Note that this repo is primarily used for Visual Studio and related products and support will be focused on those scenarios.
+
+## Microsoft Support Policy
+
+Microsoft support for this software is available only for its use in officially supported products such as Visual Studio.
+Support and servicing is limited to the latest released version.
+For more information, see [Visual Studio Product Lifecycle and Servicing](https://learn.microsoft.com/visualstudio/productinfo/vs-servicing).
+Assisted support is available from a professional support engineer by opening a ticket with the [Microsoft assisted support team](https://support.serviceshub.microsoft.com/supportforbusiness/onboarding).
diff --git a/azure-pipelines/NuGetSbom.props b/azure-pipelines/NuGetSbom.props
@@ -0,0 +1,6 @@
+<Project>
+  <PropertyGroup>
+    <GenerateSBOMThisProject>true</GenerateSBOMThisProject>
+    <UseMicroBuildSbomPluginVersion>2</UseMicroBuildSbomPluginVersion>
+  </PropertyGroup>
+</Project>
diff --git a/azure-pipelines/NuGetSbom.targets b/azure-pipelines/NuGetSbom.targets
diff --git a/azure-pipelines/build.yml b/azure-pipelines/build.yml
@@ -198,7 +198,7 @@ jobs:
       IsOptProf: ${{ parameters.IsOptProf }}
 
   - ${{ if and(parameters.EnableDotNetFormatCheck, not(parameters.EnableLinuxBuild)) }}:
-    - script: dotnet format --verify-no-changes --no-restore
+    - script: dotnet format --verify-no-changes
       displayName: 💅 Verify formatted code
       env:
         dotnetformat: true # part of a workaround for https://github.com/dotnet/sdk/issues/44951
@@ -240,7 +240,7 @@ jobs:
           Is1ESPT: ${{ parameters.Is1ESPT }}
           RunTests: ${{ parameters.RunTests }}
       - ${{ if parameters.EnableDotNetFormatCheck }}:
-        - script: dotnet format --verify-no-changes --no-restore
+        - script: dotnet format --verify-no-changes
           displayName: 💅 Verify formatted code
           env:
             dotnetformat: true # part of a workaround for https://github.com/dotnet/sdk/issues/44951
@@ -283,8 +283,16 @@ jobs:
       - macOS
     pool: ${{ parameters.windowsPool }} # Use Windows agent because PublishSymbols task requires it (https://github.com/microsoft/azure-pipelines-tasks/issues/13821).
     condition: succeededOrFailed()
+    variables:
+      ONEES_ENFORCED_CODEQL_ENABLED: false # CodeQL runs on build jobs, we don't need it here
     ${{ if eq(variables['system.collectionId'], '011b8bdf-6d56-4f87-be0d-0092136884d9') }}:
       templateContext:
+        ${{ if not(parameters.RealSign) }}:
+          mb:
+            signing: # if the build is test-signed, install the signing plugin so that CSVTestSignPolicy.xml is available
+              enabled: true
+              zipSources: false
+              signType: test
         outputParentDirectory: $(Build.ArtifactStagingDirectory)
         outputs:
           - output: pipelineArtifact
diff --git a/azure-pipelines/microbuild.after.yml b/azure-pipelines/microbuild.after.yml
@@ -9,7 +9,7 @@ parameters:
   type: boolean
 
 steps:
-- ${{ if not(parameters.SkipCodesignVerify) }}: # skip CodesignVerify on validation builds because we don't even test-sign nupkg's.
+- ${{ if not(parameters.SkipCodesignVerify) }}:
   - task: MicroBuildCodesignVerify@3
     displayName: 🔍 Verify Signed Files
     inputs:
diff --git a/azure-pipelines/prepare-insertion-stages.yml b/azure-pipelines/prepare-insertion-stages.yml
@@ -18,6 +18,8 @@ stages:
       - job: symbol_archive
         displayName: Archive symbols
         pool: VSEngSS-MicroBuild2022-1ES
+        variables:
+          ONEES_ENFORCED_CODEQL_ENABLED: false # CodeQL runs on build stages, we don't need it here
         steps:
         - checkout: none
         - download: current
@@ -61,6 +63,8 @@ stages:
             ${{ else }}:
               nuGetFeedType: internal
               publishVstsFeed: vs-impl # Leave this as-is, since non-signed builds must not be pushed to public feeds.
+        variables:
+          ONEES_ENFORCED_CODEQL_ENABLED: false # CodeQL runs on build stages, we don't need it here
         steps:
         - checkout: none
         - download: current
diff --git a/azure-pipelines/vs-validation.yml b/azure-pipelines/vs-validation.yml
@@ -32,10 +32,9 @@ extends:
     stages:
     - stage: Build
       variables:
-        DOTNET_SKIP_FIRST_TIME_EXPERIENCE: true
-        NUGET_PACKAGES: $(Agent.TempDirectory)/.nuget/packages/
-        BuildConfiguration: Release
-        SkipCodesignVerify: true
+      - template: /azure-pipelines/BuildStageVariables.yml@self
+      - name: SkipCodesignVerify
+        value: true
 
       jobs:
       - template: /azure-pipelines/build.yml@self
diff --git a/global.json b/global.json
@@ -1,6 +1,6 @@
 {
   "sdk": {
-    "version": "9.0.202",
+    "version": "9.0.300",
     "rollForward": "patch",
     "allowPrerelease": false
   },
diff --git a/tools/Get-3rdPartySymbolFiles.ps1 b/tools/Get-3rdPartySymbolFiles.ps1
@@ -0,0 +1,91 @@
+Function Get-FileFromWeb([Uri]$Uri, $OutFile) {
+    $OutDir = Split-Path $OutFile
+    if (!(Test-Path $OutFile)) {
+        Write-Verbose "Downloading $Uri..."
+        if (!(Test-Path $OutDir)) { New-Item -ItemType Directory -Path $OutDir | Out-Null }
+        try {
+            (New-Object System.Net.WebClient).DownloadFile($Uri, $OutFile)
+        }
+        finally {
+            # This try/finally causes the script to abort
+        }
+    }
+}
+
+Function Unzip($Path, $OutDir) {
+    $OutDir = (New-Item -ItemType Directory -Path $OutDir -Force).FullName
+    Add-Type -AssemblyName System.IO.Compression.FileSystem
+
+    # Start by extracting to a temporary directory so that there are no file conflicts.
+    [System.IO.Compression.ZipFile]::ExtractToDirectory($Path, "$OutDir.out")
+
+    # Now move all files from the temp directory to $OutDir, overwriting any files.
+    Get-ChildItem -Path "$OutDir.out" -Recurse -File | ForEach-Object {
+        $destinationPath = Join-Path -Path $OutDir -ChildPath $_.FullName.Substring("$OutDir.out".Length).TrimStart([io.path]::DirectorySeparatorChar, [io.path]::AltDirectorySeparatorChar)
+        if (!(Test-Path -Path (Split-Path -Path $destinationPath -Parent))) {
+            New-Item -ItemType Directory -Path (Split-Path -Path $destinationPath -Parent) | Out-Null
+        }
+        Move-Item -Path $_.FullName -Destination $destinationPath -Force
+    }
+    Remove-Item -Path "$OutDir.out" -Recurse -Force
+}
+
+Function Get-SymbolsFromPackage($id, $version) {
+    $symbolPackagesPath = "$PSScriptRoot/../obj/SymbolsPackages"
+    New-Item -ItemType Directory -Path $symbolPackagesPath -Force | Out-Null
+    $nupkgPath = Join-Path $symbolPackagesPath "$id.$version.nupkg"
+    $snupkgPath = Join-Path $symbolPackagesPath "$id.$version.snupkg"
+    $unzippedPkgPath = Join-Path $symbolPackagesPath "$id.$version"
+    Get-FileFromWeb -Uri "https://www.nuget.org/api/v2/package/$id/$version" -OutFile $nupkgPath
+    Get-FileFromWeb -Uri "https://www.nuget.org/api/v2/symbolpackage/$id/$version" -OutFile $snupkgPath
+
+    Unzip -Path $nupkgPath -OutDir $unzippedPkgPath
+    Unzip -Path $snupkgPath -OutDir $unzippedPkgPath
+
+    Get-ChildItem -Recurse -LiteralPath $unzippedPkgPath -Filter *.pdb | % {
+        # Collect the DLLs/EXEs as well.
+        $rootName = Join-Path $_.Directory $_.BaseName
+        if ($rootName.EndsWith('.ni')) {
+            $rootName = $rootName.Substring(0, $rootName.Length - 3)
+        }
+
+        $dllPath = "$rootName.dll"
+        $exePath = "$rootName.exe"
+        if (Test-Path $dllPath) {
+            $BinaryImagePath = $dllPath
+        }
+        elseif (Test-Path $exePath) {
+            $BinaryImagePath = $exePath
+        }
+        else {
+            Write-Warning "`"$_`" found with no matching binary file."
+            $BinaryImagePath = $null
+        }
+
+        if ($BinaryImagePath) {
+            Write-Output $BinaryImagePath
+            Write-Output $_.FullName
+        }
+    }
+}
+
+Function Get-PackageVersion($id) {
+    $versionProps = [xml](Get-Content -LiteralPath $PSScriptRoot\..\Directory.Packages.props)
+    $version = $versionProps.Project.ItemGroup.PackageVersion | ? { $_.Include -eq $id } | % { $_.Version }
+    if (!$version) {
+        Write-Error "No package version found in Directory.Packages.props for the package '$id'"
+    }
+
+    $version
+}
+
+# All 3rd party packages for which symbols packages are expected should be listed here.
+# These must all be sourced from nuget.org, as it is the only feed that supports symbol packages.
+$3rdPartyPackageIds = @()
+
+$3rdPartyPackageIds | % {
+    $version = Get-PackageVersion $_
+    if ($version) {
+        Get-SymbolsFromPackage -id $_ -version $version
+    }
+}
diff --git a/tools/Get-SymbolFiles.ps1 b/tools/Get-SymbolFiles.ps1
@@ -43,7 +43,7 @@ $PDBs |% {
     }
 } |% {
     # Collect the DLLs/EXEs as well.
-    $rootName = "$($_.Directory)/$($_.BaseName)"
+    $rootName = Join-Path $_.Directory $_.BaseName
     if ($rootName.EndsWith('.ni')) {
         $rootName = $rootName.Substring(0, $rootName.Length - 3)
     }
diff --git a/tools/Install-DotNetSdk.ps1 b/tools/Install-DotNetSdk.ps1
diff --git a/tools/artifacts/symbols.ps1 b/tools/artifacts/symbols.ps1
