在GitHub Actions中缓存MSBuild中间产物的增量构建问题

问题核心分析 #

你的配置存在两个关键问题：

1. 缓存Key设计错误：用github.sha作为缓存Key的唯一标识，导致每个新提交都会生成全新的Key——哪怕只是修改了Markdown这类不影响构建的文件，也会完全无法复用旧缓存，触发全量构建。
2. 文件时间戳不匹配：actions/checkout会将检出文件的时间戳设为当前流水线运行时间，而从缓存恢复的bin/obj文件时间戳是缓存时的旧时间。MSBuild判断增量构建的核心逻辑是源文件时间戳是否晚于输出文件，源文件时间更新时，会强制重新编译。

修复方案 #

1. 重构缓存Key，基于构建依赖文件哈希 #

将缓存Key改为基于影响构建的文件（如.sln、.csproj、源代码文件）的哈希值，这样只有当这些文件变化时才会失效缓存。同时保留runner.os和configuration，确保不同系统、不同配置的缓存隔离。

2. 统一文件时间戳，修复MSBuild增量判断 #

恢复缓存后，将bin/obj目录下的文件时间戳更新为不早于源文件的时间，让MSBuild认为输出文件是最新的，跳过重复编译。

3. 单独缓存NuGet包，加速Restore步骤 #

单独缓存NuGet的全局包缓存，避免每次都重新下载依赖。

完整修正后的工作流配置 #

name: Incremental Build

on:
  workflow_call:
    inputs:
      configuration:
        description: 'Build configuration'
        required: true
        type: string
        default: 'Release'

jobs:
  cache_and_build:
    runs-on: windows-latest
    steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0

      - uses: microsoft/setup-msbuild@v1

      # 缓存NuGet全局包
      - name: Cache NuGet packages
        uses: actions/cache@v3
        with:
          path: ~/.nuget/packages
          key: ${{ runner.os }}-nuget-${{ hashFiles('**/packages.lock.json') }}
          restore-keys: |
            ${{ runner.os }}-nuget-

      # 生成构建依赖文件的哈希，作为缓存Key的核心标识
      - name: Generate build dependency hash
        id: generate_hash
        shell: pwsh
        run: |
          # 收集所有影响构建的文件，可根据项目调整范围
          $files = Get-ChildItem -Recurse -Include *.sln,*.csproj,*.cs,*.vb | Sort-Object FullName
          $hash = ($files | Get-FileHash -Algorithm SHA256).Hash -join ''
          $hash = $hash.Substring(0, 32) # 缩短哈希长度，避免Key过长
          echo "build_hash=$hash" >> $env:GITHUB_OUTPUT

      # 缓存bin/obj目录
      - name: Cache build artifacts
        id: cache-build-artifacts
        uses: actions/cache@v3
        with:
          path: |
            **/bin
            **/obj
          key: ${{ runner.os }}-build-${{ inputs.configuration }}-${{ steps.generate_hash.outputs.build_hash }}
          restore-keys: |
            ${{ runner.os }}-build-${{ inputs.configuration }}-

      # 恢复NuGet包
      - name: Restore NuGet packages
        working-directory: ${{ env.GITHUB_WORKSPACE }}
        run: nuget restore
        shell: pwsh

      # 仅缓存命中时同步时间戳，确保输出文件时间不早于源文件
      - name: Sync build artifact timestamps
        if: steps.cache-build-artifacts.outputs.cache-hit == 'true'
        shell: pwsh
        run: |
          Get-ChildItem -Recurse -Path **/bin,**/obj | ForEach-Object {
            $_.LastWriteTime = Get-Date
          }

      # 执行增量构建
      - name: Build solution
        run: msbuild -m -p:Configuration=${{ inputs.configuration }} -verbosity:diagnostic
        shell: pwsh

关键说明 #

• 缓存Key逻辑：通过generate_hash步骤生成仅由构建依赖文件决定的哈希，确保无关文件修改不会触发缓存失效。
• 时间戳同步：仅当缓存命中时执行，将bin/obj文件时间戳更新为当前时间，让MSBuild判断输出文件比源文件新，从而跳过重复编译。
• NuGet缓存：利用packages.lock.json的哈希作为Key，确保依赖未变更时直接复用缓存的包。

内容的提问来源于stack exchange，提问作者Greedo