Re-enable MSBuildCache

Author: dfederm

.github/actions/spelling/expect/expect.txt

@@ -115,6 +115,7 @@ BKCOLOR
 BKGND
 BKMK
 Bksp
+blds
 Blt
 blu
 BLUESCROLL
@@ -180,6 +181,7 @@ CLIPCHILDREN
 CLIPSIBLINGS
 closetest
 cloudconsole
+CLOUDT
 cloudvault
 CLSCTX
 clsids

Directory.Build.props

@@ -33,6 +33,17 @@
       A:\;
       E:\;
       $(windir)\**;
+      $(MSBuildBinPath)\**;
+      $(MSBuildToolsPath32)\**;
+    </MSBuildCacheAllowFileAccessAfterProjectFinishFilePatterns>
+
+    <!--
+      Unit tests may write to TEMP, but should not be considered outputs. However, $(Temp) is using the DOS path (C:\Users\CLOUDT~1\AppData\Local\Temp), which
+      isn't accounted for in these globs. So we're building up to TEMP using $(LOCALAPPDATA) instead.
+    -->
+    <MSBuildCacheAllowFileAccessAfterProjectFinishFilePatterns>
+      $(MSBuildCacheAllowFileAccessAfterProjectFinishFilePatterns);
+      $(LOCALAPPDATA)\Temp\**;
     </MSBuildCacheAllowFileAccessAfterProjectFinishFilePatterns>
 
     <!-- 

build/pipelines/ci-caching.yml

@@ -84,7 +84,7 @@ stages:
             buildEverything: true
             keepAllExpensiveBuildOutputs: false
             ${{ if eq(variables['System.PullRequest.IsFork'], 'False') }}:
-              enableCaching: true
+              enableMsBuildCaching: true
 
     - ${{ if eq(parameters.runTests, true) }}:
       - stage: Test_${{ platform }}

build/pipelines/ci.yml

@@ -25,6 +25,8 @@ pr:
 variables:
   - name: runCodesignValidationInjectionBG
     value: false
+  - name: EnablePipelineCache 
+    value: true
 
 #     0.0.yyMM.dd##
 #     0.0.1904.0900
@@ -45,6 +47,10 @@ parameters:
       - x64
       - x86
       - arm64
+  - name: enableMsBuildCaching
+    type: boolean
+    displayName: "Enable MSBuild Caching"
+    default: true
 
 stages:
   - ${{ if eq(parameters.auditMode, true) }}:
@@ -87,6 +93,8 @@ stages:
             buildConfigurations: [Release]
             buildEverything: true
             keepAllExpensiveBuildOutputs: false
+            ${{ if eq(variables['System.PullRequest.IsFork'], 'False') }}:
+              enableMsBuildCaching: ${{ parameters.enableMsBuildCaching }}
 
     - ${{ if eq(parameters.runTests, true) }}:
       - stage: Test_${{ platform }}

build/pipelines/templates-v2/job-build-project.yml

@@ -68,7 +68,7 @@ parameters:
   - name: signingIdentity
     type: object
     default: {}
-  - name: enableCaching
+  - name: enableMsBuildCaching
     type: boolean
     default: false
 
@@ -144,7 +144,7 @@ jobs:
       }
     displayName: Prepare Build and Sign Targets
 
-  - ${{ if eq(parameters.enableCaching, true) }}:
+  - ${{ if eq(parameters.enableMsBuildCaching, true) }}:
     - pwsh: |-
         $MSBuildCacheParameters = ""
         $MSBuildCacheParameters += " -graph"
@@ -183,7 +183,7 @@ jobs:
       configuration: $(BuildConfiguration)
       msbuildArchitecture: x64
       maximumCpuCount: true
-    ${{ if eq(parameters.enableCaching, true) }}:
+    ${{ if eq(parameters.enableMsBuildCaching, true) }}:
       env:
         SYSTEM_ACCESSTOKEN: $(System.AccessToken)
 
@@ -192,7 +192,7 @@ jobs:
       artifact: logs-$(BuildPlatform)-$(BuildConfiguration)${{ parameters.artifactStem }}
       condition: always()
       displayName: Publish Build Log
-    - ${{ if eq(parameters.enableCaching, true) }}:
+    - ${{ if eq(parameters.enableMsBuildCaching, true) }}:
       - publish: $(Build.SourcesDirectory)\MSBuildCacheLogs
         artifact: logs-msbuildcache-$(BuildPlatform)-$(BuildConfiguration)${{ parameters.artifactStem }}
         condition: always()
@@ -203,7 +203,7 @@ jobs:
       inputs:
         contents: $(Build.SourcesDirectory)/msbuild.binlog
         TargetFolder: $(Terminal.BinDir)
-    - ${{ if eq(parameters.enableCaching, true) }}:
+    - ${{ if eq(parameters.enableMsBuildCaching, true) }}:
       - task: CopyFiles@2
         displayName: Copy MSBuildCache Logs
         inputs:

dep/nuget/packages.config

@@ -20,7 +20,7 @@
   <package id="Selenium.WebDriver" version="3.5.0" targetFramework="net45" />
 
   <!-- MSBuildCache -->
-  <package id="Microsoft.MSBuildCache.AzurePipelines" version="0.1.283-preview" />
-  <package id="Microsoft.MSBuildCache.Local" version="0.1.283-preview" />
-  <package id="Microsoft.MSBuildCache.SharedCompilation" version="0.1.283-preview" />
+  <package id="Microsoft.MSBuildCache.AzurePipelines" version="0.1.318-preview" />
+  <package id="Microsoft.MSBuildCache.Local" version="0.1.318-preview" />
+  <package id="Microsoft.MSBuildCache.SharedCompilation" version="0.1.318-preview" />
 </packages>

src/common.build.pre.props

@@ -292,6 +292,15 @@
     <VcpkgRoot Condition="'$(VcpkgRoot)'==''">$(VsInstallRoot)\VC\vcpkg</VcpkgRoot>
     <VcpkgRoot Condition="'$(VcpkgRoot)'=='' or !Exists('$(VcpkgRoot)\vcpkg.exe')">$(SolutionDir)\dep\vcpkg</VcpkgRoot>
 
+    <!--
+      Ensure the MSBuildCache ignores collecting outputs under vcpkg's build tree, which is a working directory used to build vcpkg packages and not intended to be consumed by anything else in the build.
+      Note: We cannot use $(VcpkgInstalledDir) directly since it differs between projects, so use a pattern which encompasses both.
+    -->
+    <MSBuildCacheIgnoredOutputPatterns>
+      $(MSBuildCacheIgnoredOutputPatterns);
+      $(SolutionDir)\obj\*\vcpkg*\vcpkg\blds\**;
+    </MSBuildCacheIgnoredOutputPatterns>
+
     <CAExcludePath>$(CAExcludePath);$(VcpkgInstalledDir)</CAExcludePath>
 
     <!-- For now, don't allow global-per-user installs of vcpkg -->