Select RHEL8 vcpkg-configuration.json via CMake instead of renaming the tracked file

* Select RHEL8 vcpkg-configuration.json via CMake instead of renaming the tracked file RHEL8 CI jobs previously ran 'cp vcpkg-configuration-rhel8.json vcpkg-configuration.json' before configuring, temporarily overwriting the tracked default configuration in the checkout. The vcpkg toolchain file only defaults VCPKG_MANIFEST_DIR to CMAKE_SOURCE_DIR when it is not already defined, and reads it while processing project(), so setting VCPKG_MANIFEST_DIR earlier -- before project() -- lets vcpkg read a different vcpkg-configuration.json without ever touching the tracked file. Add a RESINSIGHT_VCPKG_PROFILE cache variable, implemented in the new cmake/ResInsightVcpkgProfile.cmake (included from the root CMakeLists.txt before project(), which is required for VCPKG_MANIFEST_DIR to take effect). When set (e.g. to 'rhel8'), it copies vcpkg.json and vcpkg-configuration-<profile>.json into a profile-specific directory under the build tree and points VCPKG_MANIFEST_DIR there. The copy is regenerated on every configure, so it can never drift from the root vcpkg.json. overlay-ports/overlay-triplets entries (e.g. 'ThirdParty/vcpkg-overlay-ports') are resolved by vcpkg relative to the directory vcpkg-configuration.json lives in, so repo-relative 'ThirdParty/...' paths are rewritten to absolute paths right after the copy is generated, keeping them valid from the new location. Update the RHEL8 workflows and Dockerfile.rhel8 build-warmup stage to pass -DRESINSIGHT_VCPKG_PROFILE=rhel8 instead of the cp step, and update vcpkg-readme.md to describe the new mechanism. * #14733 Use x64-linux-release vcpkg triplet explicitly in RHEL8 CI The RHEL8 CI workflows and the Docker image's warmup/vcpkg-cache stages did not set VCPKG_TARGET_TRIPLET/VCPKG_HOST_TRIPLET, so vcpkg fell back to its plain x64-linux default triplet, which builds both debug and release variants of every dependency even though the CI build is Release-only. Set both to x64-linux-release consistently across the image's vcpkg install, the warmup CMake configure, and the two consuming workflows so the baked binary cache and the CI configure use matching ABI hashes and skip the unused debug builds.
2026-10-24 14:17:52 -05:00 · 2026-09-11 22:49:16 +02:00
1 parent 8f65fed265
commit 3052d3d554
@@ -110,15 +110,21 @@ ENV VCPKG_DEFAULT_BINARY_CACHE=/opt/vcpkg-cache
 # ordinary source commits -- nightly rebuilds reuse the previously compiled
 # vcpkg binaries instead of recompiling every port.
 COPY ThirdParty/vcpkg /src/ThirdParty/vcpkg
+COPY ThirdParty/vcpkg-overlay-ports /src/ThirdParty/vcpkg-overlay-ports
 COPY vcpkg.json /src/vcpkg.json
 COPY vcpkg-configuration-rhel8.json /src/vcpkg-configuration.json

 # A direct manifest install compiles every dependency into
-# VCPKG_DEFAULT_BINARY_CACHE. The dependency set has no manifest features or
-# overlay ports, and CC/CXX below match the ResInsight configure in the
-# warmup stage and in CI, so the vcpkg ABI hashes match and the cache is
-# reused there. x64-linux is the triplet the vcpkg CMake toolchain defaults
-# to on Linux.
+# VCPKG_DEFAULT_BINARY_CACHE. vcpkg-configuration-rhel8.json's overlay-ports
+# entry ("ThirdParty/vcpkg-overlay-ports") is resolved relative to the
+# directory vcpkg-configuration.json lives in, i.e. /src here, so that
+# directory must be copied in too, not just ThirdParty/vcpkg. CC/CXX below
+# match the ResInsight configure in the warmup stage and in CI, so the vcpkg
+# ABI hashes match and the cache is reused there. x64-linux-release matches
+# the triplet the CI workflows and the warmup stage below pass via
+# VCPKG_TARGET_TRIPLET/VCPKG_HOST_TRIPLET -- using the plain (debug+release)
+# x64-linux triplet here would populate the cache under different ABI hashes
+# and none of it would be reused downstream.
 #
 # After the install, verify the cache contains a plausible number of entries.
 # vcpkg's `files` binary provider stores one .zip per package under
@@ -132,7 +138,7 @@ RUN git config --global --add safe.directory '*' \
 && ( cd /src/ThirdParty/vcpkg && ./bootstrap-vcpkg.sh ) \
 && export CC=/opt/rh/gcc-toolset-14/root/usr/bin/gcc \
 && export CXX=/opt/rh/gcc-toolset-14/root/usr/bin/g++ \
- && ( cd /src && ./ThirdParty/vcpkg/vcpkg install --triplet x64-linux ) \
+ && ( cd /src && ./ThirdParty/vcpkg/vcpkg install --triplet x64-linux-release --host-triplet x64-linux-release ) \
 && vcpkg_zip_count=$(find "${VCPKG_DEFAULT_BINARY_CACHE}" -type f -name '*.zip' | wc -l) \
 && echo "vcpkg binary cache entries: ${vcpkg_zip_count}" \
 && test "${vcpkg_zip_count}" -ge 20 \
@@ -167,7 +173,6 @@ COPY . /src
 # (the command line is part of the hash).
 RUN --mount=type=cache,id=ri-rhel8-buildcache,target=/var/cache/buildcache,sharing=locked \
    git config --global --add safe.directory '*' \
- && cp /src/vcpkg-configuration-rhel8.json /src/vcpkg-configuration.json \
 && source /opt/rh/gcc-toolset-14/enable \
 && ( cd /src/ThirdParty/vcpkg && ./bootstrap-vcpkg.sh ) \
 && export CC=/opt/rh/gcc-toolset-14/root/usr/bin/gcc \
@@ -182,6 +187,9 @@ RUN --mount=type=cache,id=ri-rhel8-buildcache,target=/var/cache/buildcache,shari
      -DRESINSIGHT_ENABLE_HDF5=false \
      -DRESINSIGHT_ENABLE_GRPC=false \
      -DRESINSIGHT_GCC_STDCPP_EXP_PATH=/opt/libstdcxx-exp/lib \
+      -DRESINSIGHT_VCPKG_PROFILE=rhel8 \
+      -DVCPKG_TARGET_TRIPLET=x64-linux-release \
+      -DVCPKG_HOST_TRIPLET=x64-linux-release \
      -DCMAKE_TOOLCHAIN_FILE=ThirdParty/vcpkg/scripts/buildsystems/vcpkg.cmake \
 && cmake --build /src/cmakebuild --target ResInsight-tests -- -j"$(nproc)" \
 && buildcache -s \
@@ -15,6 +15,7 @@ on:
      - ".dockerignore"
      - "vcpkg.json"
      - "vcpkg-configuration-rhel8.json"
+      - "ThirdParty/vcpkg-overlay-ports/**"
      - ".gitmodules"
  workflow_dispatch:
    inputs:
@@ -78,9 +78,6 @@ jobs:
          cd ThirdParty/vcpkg
          ./bootstrap-vcpkg.sh

-      - name: Use RHEL8 vcpkg configuration
-        run: cp vcpkg-configuration-rhel8.json vcpkg-configuration.json
-
      - name: Configure CMake
        env:
          CC: /opt/rh/gcc-toolset-14/root/usr/bin/gcc
@@ -103,6 +100,9 @@ jobs:
            -DRESINSIGHT_ENABLE_HDF5=false \
            -DRESINSIGHT_ENABLE_GRPC=false \
            -DRESINSIGHT_GCC_STDCPP_EXP_PATH=/opt/libstdcxx-exp/lib \
+            -DRESINSIGHT_VCPKG_PROFILE=rhel8 \
+            -DVCPKG_TARGET_TRIPLET=x64-linux-release \
+            -DVCPKG_HOST_TRIPLET=x64-linux-release \
            -DCMAKE_TOOLCHAIN_FILE=ThirdParty/vcpkg/scripts/buildsystems/vcpkg.cmake

      - name: Build install target
@@ -80,9 +80,6 @@ jobs:
          cd ThirdParty/vcpkg
          ./bootstrap-vcpkg.sh

-      - name: Use RHEL8 vcpkg configuration
-        run: cp vcpkg-configuration-rhel8.json vcpkg-configuration.json
-
      - name: Configure CMake
        env:
          CC: /opt/rh/gcc-toolset-14/root/usr/bin/gcc
@@ -104,6 +101,9 @@ jobs:
            -DRESINSIGHT_ENABLE_HDF5=false \
            -DRESINSIGHT_ENABLE_GRPC=false \
            -DRESINSIGHT_GCC_STDCPP_EXP_PATH=/opt/libstdcxx-exp/lib \
+            -DRESINSIGHT_VCPKG_PROFILE=rhel8 \
+            -DVCPKG_TARGET_TRIPLET=x64-linux-release \
+            -DVCPKG_HOST_TRIPLET=x64-linux-release \
            -DCMAKE_TOOLCHAIN_FILE=ThirdParty/vcpkg/scripts/buildsystems/vcpkg.cmake

      - name: Build
@@ -23,6 +23,10 @@ include(FetchContent)
 # subdirectory CMakeLists.txt files pull in via their own find_package().
 set(CMAKE_FIND_PACKAGE_TARGETS_GLOBAL TRUE)

+# Must be include()'d before project() -- see cmake/ResInsightVcpkgProfile.cmake
+# for why.
+include(cmake/ResInsightVcpkgProfile.cmake)
+
 project(ResInsight)

 # Include common settings
@@ -0,0 +1,67 @@
+# Select an alternate vcpkg-configuration.json without renaming/copying any
+# tracked file. The vcpkg toolchain
+# (ThirdParty/vcpkg/scripts/buildsystems/vcpkg.cmake) defaults
+# VCPKG_MANIFEST_DIR to CMAKE_SOURCE_DIR only when it is not already defined,
+# and it must see the final value before project() triggers toolchain-file
+# processing. This file must therefore be include()'d from the root
+# CMakeLists.txt before project() is called -- code that runs after project()
+# is too late.
+#
+# A profile's vcpkg-configuration file is expected at
+# "vcpkg-configuration-${RESINSIGHT_VCPKG_PROFILE}.json" in the source root,
+# e.g. vcpkg-configuration-rhel8.json for -DRESINSIGHT_VCPKG_PROFILE=rhel8.
+# vcpkg.json is copied alongside it so both manifest files live in the same
+# directory, as vcpkg requires; the copy is regenerated on every configure so it
+# can never drift from the root vcpkg.json.
+set(RESINSIGHT_VCPKG_PROFILE
+    ""
+    CACHE
+      STRING
+      "Optional vcpkg-configuration profile, e.g. 'rhel8' to use vcpkg-configuration-rhel8.json"
+)
+if(RESINSIGHT_VCPKG_PROFILE)
+  set(_resinsight_vcpkg_profile_config
+      "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg-configuration-${RESINSIGHT_VCPKG_PROFILE}.json"
+  )
+  if(NOT EXISTS "${_resinsight_vcpkg_profile_config}")
+    message(
+      FATAL_ERROR "RESINSIGHT_VCPKG_PROFILE='${RESINSIGHT_VCPKG_PROFILE}' but "
+                  "${_resinsight_vcpkg_profile_config} does not exist"
+    )
+  endif()
+
+  set(_resinsight_vcpkg_manifest_dir
+      "${CMAKE_BINARY_DIR}/vcpkg-manifest-${RESINSIGHT_VCPKG_PROFILE}"
+  )
+  file(MAKE_DIRECTORY "${_resinsight_vcpkg_manifest_dir}")
+  configure_file(
+    "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg.json"
+    "${_resinsight_vcpkg_manifest_dir}/vcpkg.json" COPYONLY
+  )
+  configure_file(
+    "${_resinsight_vcpkg_profile_config}"
+    "${_resinsight_vcpkg_manifest_dir}/vcpkg-configuration.json" COPYONLY
+  )
+
+  # overlay-ports/overlay-triplets entries (e.g.
+  # "ThirdParty/vcpkg-overlay-ports") are resolved by vcpkg relative to the
+  # directory vcpkg-configuration.json lives in. Since the copy above now lives
+  # under the build tree instead of the source root, rewrite those repo-relative
+  # "ThirdParty/..." paths to absolute paths so they still resolve to the real
+  # source tree.
+  file(READ "${_resinsight_vcpkg_manifest_dir}/vcpkg-configuration.json"
+       _resinsight_vcpkg_profile_json
+  )
+  string(REPLACE "\"ThirdParty/" "\"${CMAKE_CURRENT_SOURCE_DIR}/ThirdParty/"
+                 _resinsight_vcpkg_profile_json
+                 "${_resinsight_vcpkg_profile_json}"
+  )
+  file(WRITE "${_resinsight_vcpkg_manifest_dir}/vcpkg-configuration.json"
+       "${_resinsight_vcpkg_profile_json}"
+  )
+
+  set(VCPKG_MANIFEST_DIR
+      "${_resinsight_vcpkg_manifest_dir}"
+      CACHE PATH "" FORCE
+  )
+endif()
@@ -16,11 +16,26 @@ The `baseline` field in each configuration file pins the vcpkg registry to a spe

 ## RHEL8 CI usage

-The workflow `.github/workflows/rhel8-unit-tests.yml` copies `vcpkg-configuration-rhel8.json` over `vcpkg-configuration.json` before invoking cmake:
+Selecting the RHEL8 configuration does not rename or overwrite the tracked
+`vcpkg-configuration.json`. Instead, the root `CMakeLists.txt` accepts a
+`RESINSIGHT_VCPKG_PROFILE` cache variable. When set, it copies `vcpkg.json`
+and `vcpkg-configuration-<profile>.json` into a profile-specific directory
+under the build tree and points vcpkg's `VCPKG_MANIFEST_DIR` at it, before
+`project()` triggers the vcpkg toolchain file. This must happen before
+`project()`: the toolchain file only defaults `VCPKG_MANIFEST_DIR` to
+`CMAKE_SOURCE_DIR` when the variable is not already defined, and it reads
+that value while processing `project()`.

-```yaml
- name: Use RHEL8 vcpkg configuration
-  run: cp vcpkg-configuration-rhel8.json vcpkg-configuration.json
+The workflows `.github/workflows/rhel8-unit-tests.yml` and
+`.github/workflows/rhel8-package.yml` (and `.github/docker/Dockerfile.rhel8`)
+select the RHEL8 baseline by passing this flag to `cmake`:
+
+```
+cmake -S /src -B /src/cmakebuild -G Ninja \
+  ... \
+  -DRESINSIGHT_VCPKG_PROFILE=rhel8 \
+  -DCMAKE_TOOLCHAIN_FILE=ThirdParty/vcpkg/scripts/buildsystems/vcpkg.cmake
 ```

-This ensures vcpkg uses the RHEL8 baseline without affecting other CI runs.
+This ensures vcpkg uses the RHEL8 baseline without affecting other CI runs,
+and without ever mutating a tracked file in the source tree.