squash! Update workflows and pre-commit

Switch to CPack for distribution of the Umbra demo

Author: HexDecimal

.github/workflows/cmake.yml

@@ -37,7 +37,6 @@ jobs:
     env:
       # Indicates the CMake build directory where project files and binaries are being produced.
       CMAKE_BUILD_DIR: ${{ github.workspace }}/build
-      archive-name: ""
 
     steps:
       - name: Install APT packages
@@ -77,41 +76,22 @@ jobs:
           -G Ninja \
           -D VCPKG_TARGET_TRIPLET="${{ matrix.triplet }}" \
           -D CMAKE_BUILD_TYPE="${{ env.BUILD_TYPE }}" \
-          -D BUILD_UMBRA_DEMO=ON
+          -D UMBRA_DEMO=ON
+          -D UMBRA_CPACK=ON
       # Build the whole project with Ninja (which is spawn by CMake).
       - name: Build
         run: cmake --build "${CMAKE_BUILD_DIR}"
       - name: Show contents of the build directory
         run: find "${CMAKE_BUILD_DIR}"
-      # Sets env.archive-name, which is used to name the distribution folder and archive.
-      - name: Set archive name
-        run: |
-          ARCHIVE_NAME=${{ env.project-name }}-`git describe --always`-${{ matrix.platform-name }}
-          echo "Archive name set to: $ARCHIVE_NAME"
-          echo "archive-name=$ARCHIVE_NAME" >> $GITHUB_ENV
       # Copy files from the CMake build and data directory into a new distribution folder.
-      - name: Package distribution
-        run: |
-          mkdir -p dist/${{ env.archive-name }}
-          cp "${CMAKE_BUILD_DIR}/bin"/* dist/${{ env.archive-name }}
-          cp -R data dist/${{ env.archive-name }}
-      - name: Show contents of the dist directory
-        run: find dist/${{ env.archive-name }}
-      # Zip the distribution folder, using the platform appropriate tools.
-      - name: Tar files
-        if: runner.os != 'Windows'
-        working-directory: ./dist
-        run: tar --format=ustar -czvf "../${{ env.archive-name }}.tar.gz" */
-      - name: Archive files
-        if: runner.os == 'Windows'
-        shell: pwsh
-        run: Compress-Archive dist/*/ ${{ env.archive-name }}.zip
+      - name: CPack
+        run: cpack --verbose --config ${{env.CMAKE_BUILD_DIR}}/CPackConfig.cmake -B dist -R `git describe --always`
       # Upload archives as artifacts, these can be downloaded from the GitHub Actions page.
       - name: "Upload Artifact"
         uses: actions/upload-artifact@v6
         with:
           name: automated-builds-${{ matrix.triplet }}
-          path: ${{ env.archive-name }}.*
+          path: dist/*.*
           retention-days: 7
           compression-level: 0
           if-no-files-found: error
@@ -121,7 +101,7 @@ jobs:
         uses: svenstaro/upload-release-action@v2
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }}
-          file: ${{ env.archive-name }}.*
+          file: dist/*.*
           file_glob: true
           tag: ${{ github.ref }}
           overwrite: true

.vscode/settings.json

@@ -14,7 +14,8 @@
         "-Wdeprecated",
     ],
     "cmake.configureSettings": {
-        "BUILD_UMBRA_DEMO": "ON"
+        "UMBRA_DEMO": "ON",
+        "UMBRA_CPACK": "ON"
     },
     "files.associations": {
         "cstdint": "cpp",

CMakeLists.txt

@@ -11,10 +11,6 @@ project(
     LANGUAGES C CXX
 )
 
-if(NOT DEFINED CMAKE_RUNTIME_OUTPUT_DIRECTORY)
-    set(CMAKE_RUNTIME_OUTPUT_DIRECTORY "${PROJECT_BINARY_DIR}/bin")  # Keep all runtime files in one directory.
-endif()
-
 file(
     GLOB_RECURSE SOURCE_FILES CONFIGURE_DEPENDS
     ${PROJECT_SOURCE_DIR}/src/umbra/*.cpp
@@ -50,7 +46,17 @@ target_link_libraries(
 )
 add_library(umbra::umbra ALIAS ${PROJECT_NAME})
 
-set(BUILD_UMBRA_DEMO OFF CACHE BOOL "Build the demo program.")
-if(BUILD_UMBRA_DEMO)
+option(UMBRA_DEMO "Build the Umbra demo program" OFF)
+if(UMBRA_DEMO)
     add_subdirectory(src/demo)
 endif()
+
+option(UMBRA_CPACK "Enable CPack for Umbra" OFF)
+if(UMBRA_CPACK)
+    if (WIN32)
+        set(CPACK_GENERATOR "ZIP")
+    else()
+        set(CPACK_GENERATOR "TGZ")
+    endif()
+    include(CPack)
+endif()

src/demo/CMakeLists.txt

@@ -33,3 +33,13 @@ target_link_libraries(
         libtcod::libtcod
         umbra::umbra
 )
+
+# Portable install
+install(
+    TARGETS ${PROJECT_NAME}
+    DESTINATION ${PROJECT_NAME}
+)
+install(
+    DIRECTORY ../../data
+    DESTINATION ${PROJECT_NAME}
+)