Add pre-commit hook and scripts to manage submodule SHAs to ensure submodules consistency when using remotes/devtools install_github w or wo ref

Author: yannrichet

.gitmodules-shas

@@ -0,0 +1,5 @@
+# This file records the specific commit SHAs for each submodule
+# It is automatically generated and should be updated when submodules are updated
+# Format: <submodule_path> <commit_sha>
+src/libK b23966bf6c44edbc098aa4f0c2aeb2e3f8261645
+src/slapack 72a7f3753e02b0471e93296f2b22877c6fee7328

tools/pre-commit-submodule-hook.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+# Pre-commit hook to ensure .gitmodules-shas is updated when submodules change
+# To install this hook: cp tools/pre-commit-submodule-hook.sh .git/hooks/pre-commit
+
+set -e
+
+# Check if any submodule changes are being committed
+if git diff --cached --name-only | grep -q "^src/libK\|^src/slapack"; then
+  echo "Submodule changes detected, updating .gitmodules-shas..."
+  
+  # Update the .gitmodules-shas file
+  ./tools/update_submodule_shas.sh
+  
+  # Stage the updated file
+  git add .gitmodules-shas
+  
+  echo "✓ .gitmodules-shas updated and staged"
+fi

tools/setup.sh

@@ -32,6 +32,12 @@ if [ ! -f "$LIBKRIGING_SRC_PATH/CMakeLists.txt" ]; then
       # Manually clone each submodule
       echo "  → Not a git repository, manually cloning submodules..."
 
+      # Check if .gitmodules-shas file exists (contains specific commit SHAs)
+      SHAS_FILE=".gitmodules-shas"
+      if [ -f "$SHAS_FILE" ]; then
+        echo "  → Found $SHAS_FILE with pinned submodule versions"
+      fi
+      
       # Parse .gitmodules and clone each submodule
       while IFS= read -r line; do
         if echo "$line" | grep -q "^\[submodule"; then
@@ -45,9 +51,30 @@ if [ ! -f "$LIBKRIGING_SRC_PATH/CMakeLists.txt" ]; then
 
           # When we have both path and URL, clone the submodule
           if [ -n "$current_path" ] && [ -n "$current_url" ]; then
-            echo "    → Cloning $current_url into $current_path..."
-            rm -rf "$current_path"
-            git clone --depth 1 --recursive "$current_url" "$current_path"
+            # Check if we have a specific commit SHA for this submodule
+            target_sha=""
+            if [ -f "$SHAS_FILE" ]; then
+              target_sha=$(grep "^${current_path} " "$SHAS_FILE" | awk '{print $2}')
+            fi
+            
+            if [ -n "$target_sha" ]; then
+              echo "    → Cloning $current_url into $current_path at commit $target_sha..."
+              rm -rf "$current_path"
+              # Clone and checkout specific commit
+              git clone --no-checkout "$current_url" "$current_path"
+              cd "$current_path"
+              git checkout "$target_sha"
+              # Initialize nested submodules if any
+              if [ -f ".gitmodules" ]; then
+                git submodule update --init --recursive
+              fi
+              cd - > /dev/null
+            else
+              echo "    → Cloning $current_url into $current_path (latest)..."
+              rm -rf "$current_path"
+              git clone --depth 1 --recursive "$current_url" "$current_path"
+            fi
+            
             current_path=""
             current_url=""
           fi

tools/update_submodule_shas.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+# This script updates the .gitmodules-shas file with the current submodule commit SHAs
+# Run this script whenever submodules are updated before creating a new tag/release
+
+set -eo pipefail
+
+echo "Updating .gitmodules-shas with current submodule commits..."
+
+# Get the list of submodules and their commits
+git ls-tree HEAD $(git config --file .gitmodules --get-regexp path | awk '{ print $2 }') > .gitmodules-shas.tmp
+
+# Add header and format
+{
+  echo "# This file records the specific commit SHAs for each submodule"
+  echo "# It is automatically generated and should be updated when submodules are updated"
+  echo "# Format: <submodule_path> <commit_sha>"
+  awk '{print $4, $3}' .gitmodules-shas.tmp
+} > .gitmodules-shas
+
+rm -f .gitmodules-shas.tmp
+
+echo "✓ Updated .gitmodules-shas:"
+cat .gitmodules-shas
+
+echo ""
+echo "⚠ Don't forget to commit this file:"
+echo "   git add .gitmodules-shas"
+echo "   git commit -m 'Update submodule SHAs'"