Merge pull request #1019 from Devsh-Graphics-Programming/nscFixes

AnastaZIuk · web-flow · commit 38e7b5bed07b · 2026-03-18T07:31:25.000+01:00
Package NSC debug symbols and source artifact
diff --git a/.github/workflows/build-nabla.yml b/.github/workflows/build-nabla.yml
@@ -14,8 +14,42 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
+  prepare-host-rg:
+    name: Prepare host ripgrep
+    runs-on: windows-2022
+
+    steps:
+      - name: Restore ripgrep host tool
+        id: cache-rg
+        uses: actions/cache@v4
+        with:
+          path: ${{ runner.temp }}\ripgrep-14.1.1-x86_64-pc-windows-msvc
+          key: ripgrep-14.1.1-x86_64-pc-windows-msvc
+
+      - name: Install ripgrep host tool
+        if: steps.cache-rg.outputs.cache-hit != 'true'
+        shell: pwsh
+        run: |
+          $rgVersion = '14.1.1'
+          $archive = Join-Path $env:RUNNER_TEMP "ripgrep-$rgVersion-x86_64-pc-windows-msvc.zip"
+          $extractRoot = $env:RUNNER_TEMP
+          Invoke-WebRequest `
+            -Uri "https://github.com/BurntSushi/ripgrep/releases/download/$rgVersion/ripgrep-$rgVersion-x86_64-pc-windows-msvc.zip" `
+            -OutFile $archive
+          Expand-Archive -Path $archive -DestinationPath $extractRoot -Force
+
+      - name: Verify ripgrep host tool
+        shell: pwsh
+        run: |
+          $rgExe = Join-Path $env:RUNNER_TEMP 'ripgrep-14.1.1-x86_64-pc-windows-msvc\rg.exe'
+          if (-not (Test-Path $rgExe)) {
+            throw "ripgrep was not installed on host."
+          }
+          & $rgExe --version
+
   build-windows:
     name: Nabla (${{ matrix.os }}, ${{ matrix.vendor }}-${{ matrix.tag }}, ${{ matrix.config }})
+    needs: prepare-host-rg
     runs-on: ${{ matrix.os }}
 
     env:
@@ -124,6 +158,24 @@ jobs:
         with:
           submodules: 'recursive'
 
+      - name: Restore ripgrep host tool
+        id: cache-rg
+        uses: actions/cache@v4
+        with:
+          path: ${{ runner.temp }}\ripgrep-14.1.1-x86_64-pc-windows-msvc
+          key: ripgrep-14.1.1-x86_64-pc-windows-msvc
+
+      - name: Add ripgrep to PATH
+        shell: pwsh
+        run: |
+          $rgDir = Join-Path $env:RUNNER_TEMP 'ripgrep-14.1.1-x86_64-pc-windows-msvc'
+          $rgExe = Join-Path $rgDir 'rg.exe'
+          if (-not (Test-Path $rgExe)) {
+            throw "ripgrep was not installed on host."
+          }
+          $rgDir | Out-File -FilePath $env:GITHUB_PATH -Encoding utf8 -Append
+          & $rgExe --version
+
       - name: Pull Image
         run: |
           docker pull "${{ env.image }}:${{ matrix.tag }}"
@@ -297,6 +349,39 @@ jobs:
         run: |
           tar -cvf "${{ steps.set-prefix.outputs.prefix }}-profiling.tar" profiling
           tar -cvf "${{ steps.set-prefix.outputs.prefix }}-install.tar" ${{ env.install }}
+          $sourceTar = "${{ steps.set-prefix.outputs.prefix }}-source.tar"
+          $sourceFiles = @(
+            rg --files -uu . `
+              -g '*.c' -g '*.cc' -g '*.cpp' -g '*.cxx' `
+              -g '*.h' -g '*.hh' -g '*.hpp' -g '*.hxx' `
+              -g '*.inc' -g '*.inl' -g '*.ipp' -g '*.tpp' -g '*.ixx' `
+              -g '!examples_tests/media/**' -g '!.git/**'
+          ) | Sort-Object -Unique
+
+          if ($sourceFiles.Count -eq 0) {
+            throw "No source-like files found for source artifact packaging."
+          }
+
+          $archiveStream = [System.IO.File]::Open($sourceTar, [System.IO.FileMode]::Create, [System.IO.FileAccess]::Write, [System.IO.FileShare]::None)
+          try {
+            $tarWriter = [System.Formats.Tar.TarWriter]::new($archiveStream, [System.Formats.Tar.TarEntryFormat]::Pax, $false)
+            try {
+              foreach ($sourceFile in $sourceFiles) {
+                $entryName = $sourceFile -replace '\\', '/'
+                if ($entryName.StartsWith('./')) {
+                  $entryName = $entryName.Substring(2)
+                }
+                $sourcePath = (Resolve-Path -LiteralPath $sourceFile).Path
+                $tarWriter.WriteEntry($sourcePath, $entryName)
+              }
+            }
+            finally {
+              $tarWriter.Dispose()
+            }
+          }
+          finally {
+            $archiveStream.Dispose()
+          }
 
       - name: Upload NSC Godbolt Image artifact
         uses: actions/upload-artifact@v4
@@ -331,6 +416,12 @@ jobs:
           name: ${{ steps.set-prefix.outputs.prefix }}-install
           path: ${{ steps.set-prefix.outputs.prefix }}-install.tar
 
+      - name: Upload source artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ steps.set-prefix.outputs.prefix }}-source
+          path: ${{ steps.set-prefix.outputs.prefix }}-source.tar
+
       - name: Login to GHCR
         if: steps.set-prefix.outputs.shouldPushImage == 'True'
         run: echo "${{ secrets.CR_PAT }}" | docker login ghcr.io -u $env:GITHUB_ACTOR --password-stdin
diff --git a/cmake/common.cmake b/cmake/common.cmake
@@ -361,6 +361,10 @@ function(nbl_install_exe_spec _TARGETS _RELATIVE_DESTINATION)
 	endif()
 	
 	install(TARGETS ${_TARGETS} ${_EXPORT_ARGS} RUNTIME DESTINATION ${_DEST_GE_} COMPONENT ${_COMPONENT})
+
+	foreach(_TRGT IN LISTS _TARGETS)
+		install(PROGRAMS $<TARGET_PDB_FILE:${_TRGT}> DESTINATION debug/exe/${_RELATIVE_DESTINATION} CONFIGURATIONS Debug COMPONENT ${_COMPONENT})
+	endforeach()
 	
 	foreach(_TRGT IN LISTS _TARGETS)
 		get_property(_DEFINED_PROPERTY_
diff --git a/tools/nsc/CMakeLists.txt b/tools/nsc/CMakeLists.txt
@@ -267,9 +267,20 @@ set(NBL_NSC_COMPILE_COMMAND
 set(NBL_NSC_PREINSTALL_TARGET_EXE_DIRECTORY "${NBL_NSC_PREINSTALL_DIRECTORY}/${NBL_PACKAGE_RUNTIME_EXE_DIR_PATH}")
 set(NBL_NSC_PREINSTALL_TARGET_EXE_FILENAME $<TARGET_FILE_NAME:${EXECUTABLE_NAME}>)
 set(NBL_NSC_PREINSTALL_TARGET_EXE_FILEPATH "${NBL_NSC_PREINSTALL_TARGET_EXE_DIRECTORY}/${NBL_NSC_PREINSTALL_TARGET_EXE_FILENAME}")
+set(NBL_NSC_PREINSTALL_TARGET_PDB_FILENAME $<TARGET_PDB_FILE_NAME:${EXECUTABLE_NAME}>)
+set(NBL_NSC_PREINSTALL_TARGET_PDB_FILEPATH "${NBL_NSC_PREINSTALL_TARGET_EXE_DIRECTORY}/${NBL_NSC_PREINSTALL_TARGET_PDB_FILENAME}")
 set(NBL_NSC_BUILD_INFO_FILENAME build-info.json)
 set(NBL_NSC_PREINSTALL_TARGET_BUILD_INFO "${NBL_NSC_PREINSTALL_TARGET_EXE_DIRECTORY}/${NBL_NSC_BUILD_INFO_FILENAME}")
 
+add_test(NAME NBL_NSC_INSTALL_EXECUTABLES_PDB_TEST
+	COMMAND "${CMAKE_COMMAND}"
+		-DNBL_CONFIG=$<CONFIG>
+		-DNBL_PDB_FILEPATH=${NBL_NSC_PREINSTALL_TARGET_PDB_FILEPATH}
+		-P "${CMAKE_CURRENT_SOURCE_DIR}/cmake/VerifyInstalledExecutablePdb.cmake"
+	COMMAND_EXPAND_LISTS
+)
+set_tests_properties(NBL_NSC_INSTALL_EXECUTABLES_PDB_TEST PROPERTIES DEPENDS NBL_NSC_INSTALL_EXECUTABLES_TEST)
+
 add_test(NAME NBL_NSC_COMPILE_AT_EXE_CWD_TEST
 	COMMAND "${NBL_NSC_PREINSTALL_TARGET_EXE_FILENAME}" ${NBL_NSC_COMPILE_COMMAND}
 	WORKING_DIRECTORY "${NBL_NSC_PREINSTALL_TARGET_EXE_DIRECTORY}"
diff --git a/tools/nsc/cmake/VerifyInstalledExecutablePdb.cmake b/tools/nsc/cmake/VerifyInstalledExecutablePdb.cmake
@@ -0,0 +1,15 @@
+if(NOT DEFINED NBL_CONFIG)
+	message(FATAL_ERROR "NBL_CONFIG is not set.")
+endif()
+
+if(NOT DEFINED NBL_PDB_FILEPATH)
+	message(FATAL_ERROR "NBL_PDB_FILEPATH is not set.")
+endif()
+
+if(NOT NBL_CONFIG STREQUAL "Debug")
+	return()
+endif()
+
+if(NOT EXISTS "${NBL_PDB_FILEPATH}")
+	message(FATAL_ERROR "Expected installed NSC PDB at \"${NBL_PDB_FILEPATH}\".")
+endif()
