Add symbols server support for Windows releases (#4784)

pepone · web-flow · commit b358cf2b4f21 · 2025-12-18T23:03:49.000+01:00
diff --git a/.github/actions/install-windows-debug-tools/action.yml b/.github/actions/install-windows-debug-tools/action.yml
@@ -16,6 +16,14 @@ runs:
         $args = '/quiet /norestart /features OptionId.WindowsDesktopDebuggers /log "{0}"' -f $logPath
         $p = Start-Process -FilePath $sdkPath -ArgumentList $args -PassThru -Wait
 
+    - name: Add Debug Tools to PATH
+      shell: pwsh
+      run: |
+        $debugToolsPath = "C:\Program Files (x86)\Windows Kits\10\Debuggers\x64"
+        $srcsrvPath = "$debugToolsPath\srcsrv"
+        echo "$debugToolsPath" >> $env:GITHUB_PATH
+        echo "$srcsrvPath" >> $env:GITHUB_PATH
+
     - name: Upload SDK install log
       if: failure()
       uses: actions/upload-artifact@v4
diff --git a/.github/workflows/build-cpp-nuget-packages.yml b/.github/workflows/build-cpp-nuget-packages.yml
@@ -6,11 +6,18 @@ on:
       ice_version:
         required: false
         type: string
+      run_id:
+        description: "The run ID to use for downloading artifacts"
+        required: true
+        type: string
   workflow_dispatch:
     inputs:
       ice_version:
         description: "The Ice version to build"
         required: false
+      run_id:
+        description: "The run ID to use for downloading artifacts"
+        required: true
 
 jobs:
   build-cpp-nuget-packages:
@@ -22,28 +29,17 @@ jobs:
       - name: Setup C++
         uses: ./.github/actions/setup-cpp
 
-      - name: Setup Java
-        uses: ./.github/actions/setup-java
-
-      - name: Build C++ Binaries
-        run: msbuild /m ice.proj /t:BuildDist /p:BuildAllConfigurations=yes
-        working-directory: cpp/msbuild
-
-      - name: Sign C++ Binaries with Trusted Signing
-        uses: azure/trusted-signing-action@v0
-        with:
-          azure-tenant-id: ${{ secrets.AZURE_TENANT_ID }}
-          azure-client-id: ${{ secrets.AZURE_CLIENT_ID }}
-          azure-client-secret: ${{ secrets.AZURE_CLIENT_SECRET }}
-          endpoint: https://eus.codesigning.azure.net/
-          trusted-signing-account-name: zeroc
-          certificate-profile-name: zeroc-ice
-          files-folder: ./cpp/bin
-          files-folder-recurse: true
-          files-folder-filter: exe,dll
-          file-digest: SHA256
-          timestamp-rfc3161: http://timestamp.acs.microsoft.com
-          timestamp-digest: SHA256
+      - name: Download C++ Binaries
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh run download "${{ inputs.run_id }}" --repo ${{ github.repository }} --name windows-cpp-x64-Release-build --dir cpp
+          gh run download "${{ inputs.run_id }}" --repo ${{ github.repository }} --name windows-cpp-x64-Debug-build --dir cpp
+          gh run download "${{ inputs.run_id }}" --repo ${{ github.repository }} --name windows-cpp-Win32-Release-build --dir cpp
+          gh run download "${{ inputs.run_id }}" --repo ${{ github.repository }} --name windows-cpp-Win32-Debug-build --dir cpp
+          # Download Slice Tools (We only need the Release x64 build)
+          gh run download "${{ inputs.run_id }}" --repo ${{ github.repository }} --name windows-cpp-slice-tools `
+            --dir cpp/tools/ZeroC.Ice.Slice.Tools.Cpp/bin
 
       - name: Ice Package Version
         if: ${{ inputs.ice_version != '' }}
@@ -61,10 +57,3 @@ jobs:
           name: windows-cpp-nuget-packages
           path: |
             cpp/msbuild/ZeroC.Ice.Cpp/*.nupkg
-
-      - name: Upload C++ Binaries
-        uses: actions/upload-artifact@v4
-        with:
-          name: windows-cpp-binaries
-          path: |
-            cpp/bin/x64/Release/
diff --git a/.github/workflows/build-cpp-windows-binaries.yml b/.github/workflows/build-cpp-windows-binaries.yml
@@ -0,0 +1,67 @@
+name: "Build C++ Windows Binaries"
+
+on:
+  workflow_call:
+    inputs:
+      ice_version:
+        required: false
+        type: string
+  workflow_dispatch:
+    inputs:
+      ice_version:
+        description: "The Ice version to build"
+        required: false
+
+jobs:
+  build-cpp-windows-binaries:
+    runs-on: windows-2022
+    strategy:
+      matrix:
+        platform: [x64, Win32]
+        configuration: [Release, Debug]
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup C++
+        uses: ./.github/actions/setup-cpp
+
+      - name: Build C++ Binaries
+        run: |
+          msbuild /m ice.proj /t:BuildDist /p:Configuration=${{ matrix.configuration }} /p:Platform=${{ matrix.platform }}
+        working-directory: cpp/msbuild
+
+      - name: Sign C++ Binaries with Trusted Signing
+        uses: azure/trusted-signing-action@v0
+        with:
+          azure-tenant-id: ${{ secrets.AZURE_TENANT_ID }}
+          azure-client-id: ${{ secrets.AZURE_CLIENT_ID }}
+          azure-client-secret: ${{ secrets.AZURE_CLIENT_SECRET }}
+          endpoint: https://eus.codesigning.azure.net/
+          trusted-signing-account-name: zeroc
+          certificate-profile-name: zeroc-ice
+          files-folder: ./cpp/bin/${{ matrix.platform }}/${{ matrix.configuration }}
+          files-folder-filter: exe,dll
+          file-digest: SHA256
+          timestamp-rfc3161: http://timestamp.acs.microsoft.com
+          timestamp-digest: SHA256
+
+      - name: Upload C++ Build
+        uses: actions/upload-artifact@v4
+        with:
+          name: windows-cpp-${{ matrix.platform }}-${{ matrix.configuration }}-build
+          path: |
+            cpp/bin/${{ matrix.platform }}/${{ matrix.configuration }}/
+            cpp/lib/${{ matrix.platform }}/${{ matrix.configuration }}/
+            cpp/include/generated/${{ matrix.platform }}/${{ matrix.configuration }}/
+            cpp/src/**/msbuild/**/${{ matrix.platform }}/${{ matrix.configuration }}/*.cpp
+            cpp/src/**/msbuild/**/${{ matrix.platform }}/${{ matrix.configuration }}/*.h
+
+      - name: Upload C++ Slice Tools
+        uses: actions/upload-artifact@v4
+        # We only need to upload the Slice Tools once (Release x64 build) which are included in the Nuget packages
+        if: ${{ matrix.configuration == 'Release' && matrix.platform == 'x64' }}
+        with:
+          name: windows-cpp-slice-tools
+          path: |
+            cpp/tools/ZeroC.Ice.Slice.Tools.Cpp/bin
diff --git a/.github/workflows/build-release.yml b/.github/workflows/build-release.yml
@@ -159,12 +159,35 @@ jobs:
       ice_version: ${{ needs.set-version.outputs.rpm_version }}
     secrets: inherit
 
+  build-cpp-windows-binaries:
+    name: Build C++ Windows Binaries
+    uses: ./.github/workflows/build-cpp-windows-binaries.yml
+    needs: set-version
+    with:
+      ice_version: ${{ needs.set-version.outputs.semver_version }}
+    secrets: inherit
+
+  build-symbols-sources-store:
+    name: Build Symbols and Sources Store
+    uses: ./.github/workflows/build-symbols-sources-store.yml
+    needs:
+      - set-version
+      - build-cpp-windows-binaries
+    with:
+      ice_version: ${{ needs.set-version.outputs.semver_version }}
+      channel: ${{ inputs.channel }}
+      run_id: ${{ github.run_id }}
+    secrets: inherit
+
   build-cpp-nuget-packages:
     name: Build C++ NuGet Packages
     uses: ./.github/workflows/build-cpp-nuget-packages.yml
-    needs: set-version
+    needs:
+      - set-version
+      - build-cpp-windows-binaries
     with:
       ice_version: ${{ needs.set-version.outputs.semver_version }}
+      run_id: ${{ github.run_id }}
     secrets: inherit
 
   build-icegridgui-jar:
@@ -180,7 +203,7 @@ jobs:
     uses: ./.github/workflows/build-windows-msi.yml
     needs:
       - set-version
-      - build-cpp-nuget-packages
+      - build-cpp-windows-binaries
       - build-icegridgui-jar
     with:
       ice_version: ${{ needs.set-version.outputs.semver_version }}
diff --git a/.github/workflows/build-symbols-sources-store.yml b/.github/workflows/build-symbols-sources-store.yml
@@ -0,0 +1,82 @@
+name: "Build Symbols and Sources Store"
+
+on:
+  workflow_call:
+    inputs:
+      ice_version:
+        required: true
+        type: string
+      channel:
+        required: true
+        type: string
+      run_id:
+        description: "The run ID to use for downloading artifacts"
+        required: true
+        type: string
+  workflow_dispatch:
+    inputs:
+      ice_version:
+        description: "The Ice version (e.g., 3.8.0)"
+        required: true
+      channel:
+        description: "Release channel (e.g., 3.8, nightly)"
+        required: true
+        default: "nightly"
+      run_id:
+        description: "The run ID of a successful build-cpp-windows-binaries workflow run"
+        required: true
+
+jobs:
+  build-symbols-sources-store:
+    runs-on: windows-2022
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: ./.github/actions/setup-python
+
+      - name: Install Windows Debug Tools
+        uses: ./.github/actions/install-windows-debug-tools
+
+      - name: Download C++ Windows Binaries
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh run download "${{ inputs.run_id }}" --repo ${{ github.repository }} --name windows-cpp-x64-Release-build --dir cpp
+          gh run download "${{ inputs.run_id }}" --repo ${{ github.repository }} --name windows-cpp-x64-Debug-build --dir cpp
+          gh run download "${{ inputs.run_id }}" --repo ${{ github.repository }} --name windows-cpp-Win32-Release-build --dir cpp
+          gh run download "${{ inputs.run_id }}" --repo ${{ github.repository }} --name windows-cpp-Win32-Debug-build --dir cpp
+
+      - name: Compute Source Base URL
+        id: source-url
+        run: |
+          if ("${{ inputs.channel }}" -eq "nightly") {
+            $url = "https://download.zeroc.com/ice/nightly/sources/"
+          } else {
+            $url = "https://symbols.zeroc.com/sources/ice/"
+          }
+          echo "source_base_url=$url" >> $env:GITHUB_OUTPUT
+        shell: pwsh
+
+      - name: Index PDBs and Sources
+        run: |
+          python packaging/release/index-ice-pdb-sources.py `
+            --source-dir ${{ github.workspace }} `
+            --version ${{ inputs.ice_version }} `
+            --source-base-url ${{ steps.source-url.outputs.source_base_url }} `
+            --output-dir ${{ github.workspace }}/symbols-sources
+
+      - name: Create Symbols Store
+        run: |
+          symstore add /3 /r /t "Ice for C++" `
+            /v "${{ inputs.ice_version }}" `
+            /s "${{ github.workspace }}/symbols-sources/symbols/${{ inputs.ice_version }}/" `
+            /f "${{ github.workspace }}/symbols-sources/pdbs/${{ inputs.ice_version }}/" `
+            /compress
+
+      - name: Upload Symbols and Sources
+        uses: actions/upload-artifact@v4
+        with:
+          name: windows-symbols-sources
+          path: ${{ github.workspace }}/symbols-sources/
diff --git a/.github/workflows/build-windows-msi.yml b/.github/workflows/build-windows-msi.yml
@@ -33,7 +33,7 @@ jobs:
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: |
-          gh run download "${{ inputs.run_id }}" --repo ${{ github.repository }} --name windows-cpp-binaries --dir cpp/bin/x64/Release
+          gh run download "${{ inputs.run_id }}" --repo ${{ github.repository }} --name windows-cpp-x64-Release-build --dir cpp
           gh run download "${{ inputs.run_id }}" --repo ${{ github.repository }} --name icegridgui-jar --dir java/lib
 
       # MSI packaging depends on VCInstallDir to locate The C++ merge modules
diff --git a/.github/workflows/publish-release.yml b/.github/workflows/publish-release.yml
@@ -21,7 +21,6 @@ on:
         type: string
 
 jobs:
-
   publish-brew-packages:
     uses: ./.github/workflows/publish-brew-packages.yml
     with:
@@ -106,6 +105,13 @@ jobs:
       run_id: ${{ inputs.run_id }}
     secrets: inherit
 
+  publish-symbols-sources:
+    uses: ./.github/workflows/publish-symbols-sources.yml
+    with:
+      channel: ${{ inputs.channel }}
+      run_id: ${{ inputs.run_id }}
+    secrets: inherit
+
   invalidate-cloudfront-cache:
     runs-on: ubuntu-24.04
     needs:
@@ -121,6 +127,7 @@ jobs:
       - publish-rpm-packages
       - publish-swift-packages
       - publish-xcframework-packages
+      - publish-symbols-sources
     steps:
       - name: Invalidate CloudFront Cache
         run: |
diff --git a/.github/workflows/publish-symbols-sources.yml b/.github/workflows/publish-symbols-sources.yml
@@ -0,0 +1,43 @@
+name: "Publish Symbols and Sources"
+
+on:
+  workflow_dispatch:
+    inputs:
+      channel:
+        description: "The channel to publish to (e.g., 3.8, nightly)"
+        required: true
+      run_id:
+        description: "The run ID to use for downloading artifacts"
+        required: true
+  workflow_call:
+    inputs:
+      channel:
+        required: true
+        type: string
+      run_id:
+        required: true
+        type: string
+
+jobs:
+  publish-symbols-sources:
+    name: "Publish Symbols and Sources"
+    if: ${{ inputs.channel == 'nightly' }}
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Download Symbols and Sources artifacts
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          RUN_ID: ${{ inputs.run_id }}
+        run: |
+          mkdir -p staging
+          gh run download "$RUN_ID" --repo zeroc-ice/ice --pattern "windows-symbols-sources" --dir staging
+
+      - name: Publish Symbols and Sources
+        run: |
+          # Upload sources to S3 (version is already in the directory structure)
+          aws s3 sync "staging/windows-symbols-sources/sources/" "s3://zeroc-downloads/ice/nightly/sources/"
+          # Upload symbol store to S3
+          aws s3 sync "staging/windows-symbols-sources/symbols/" "s3://zeroc-downloads/ice/nightly/symbols/"
+        env:
+          AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
+          AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
diff --git a/.github/workflows/upload-release-assets.yml b/.github/workflows/upload-release-assets.yml
@@ -59,6 +59,7 @@ jobs:
           gh run download "$RUN_ID" --repo zeroc-ice/ice --pattern "pip-packages-*" --dir staging
           gh run download "$RUN_ID" --repo zeroc-ice/ice --pattern "rpm-packages-*" --dir staging
           gh run download "$RUN_ID" --repo zeroc-ice/ice --pattern "icegridgui-jar" --dir staging
+          gh run download "$RUN_ID" --repo zeroc-ice/ice --pattern "windows-symbols-sources" --dir staging
 
       - name: Download artifacts for Homebrew Bottle
         # Homebrew bottles are only built for nightly releases
diff --git a/cpp/msbuild/ice.proj b/cpp/msbuild/ice.proj
@@ -117,7 +117,7 @@
     </Target>
 
     <!-- Create nuget packages -->
-    <Target Name="Pack">
+    <Target Name="Pack" DependsOnTargets="GetNuGet">
         <RemoveDir Directories="ZeroC.Ice.Cpp" />
 
         <MSBuild Projects="ice.nuget.targets"
diff --git a/packaging/release/index-ice-pdb-sources.py b/packaging/release/index-ice-pdb-sources.py
diff --git a/packaging/release/prepare-release-assets.sh b/packaging/release/prepare-release-assets.sh
