From 485eada701d23f406b786dd8eab0cc57db86ca00 Mon Sep 17 00:00:00 2001
From: Heikki Linnakangas <heikki@neon.tech>
Date: Mon, 16 Sep 2024 22:30:59 +0300
Subject: [PATCH] Add a check that vendor/postgres-* submodules are up-to-date
 (#8949)

We frequently mess up our submodule references. This adds one
safeguard: it checks that the submodule references point to the
corresponding REL_*_STABLE_neon branches, or to some commit descending
from them.

As next step, I'm thinking that we should automate things so that when
you merge a PR to the 'neon' repository that updates the submodule
references, the REL_*_STABLE_neon branches are automatically updated
to match the submodule references. That way, you never need to
manually merge PRs in the postgres repository, it's all triggered from
commits in the 'neon' repository. But that's not included here.
---
 .github/workflows/build_and_test.yml | 50 ++++++++++++++++++++++++++++
 1 file changed, 50 insertions(+)

diff --git a/.github/workflows/build_and_test.yml b/.github/workflows/build_and_test.yml
index a210c962cb..68b2e31bcf 100644
--- a/.github/workflows/build_and_test.yml
+++ b/.github/workflows/build_and_test.yml
@@ -120,6 +120,55 @@ jobs:
       - name: Run mypy to check types
         run: poetry run mypy .
 
+  # Check that the vendor/postgres-* submodules point to the
+  # corresponding REL_*_STABLE_neon branches.
+  check-submodules:
+    runs-on: ubuntu-22.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          submodules: true
+
+      # We need more history, to find the common ancestor between each REL_14_* branch.
+      # 3 months should be plenty.
+      - name: Checkout more history
+        id: checkout-deeper
+        run: git submodule foreach git fetch --shallow-since='3 months'
+
+      - name: Check vendor/postgres-v14 submodule reference
+        id: postgres-v14-submodule
+        run: |
+            cd vendor/postgres-v14
+            git fetch origin "refs/heads/REL_14_STABLE_neon:refs/heads/origin/REL_14_STABLE_neon"
+            RC=$(git merge-base --is-ancestor origin/REL_14_STABLE_neon HEAD; echo $?)
+            if [ "$RC" != "0" ]; then
+              echo "vendor/postgres-v14 submodule is not an ancestor of the REL_14_STABLE_neon branch. Please rebase it"
+              exit 1
+            fi
+
+      - name: Check vendor/postgres-v15 submodule reference
+        id: postgres-v15-submodule
+        run: |
+            cd vendor/postgres-v15
+            git fetch origin "refs/heads/REL_14_STABLE_neon:refs/heads/origin/REL_14_STABLE_neon"
+            RC=$(git merge-base --is-ancestor origin/REL_14_STABLE_neon HEAD; echo $?)
+            if [ "$RC" != "0" ]; then
+              echo "vendor/postgres-v15 submodule is not an ancestor of the REL_14_STABLE_neon branch. Please rebase it"
+              exit 1
+            fi
+
+      - name: Check vendor/postgres-v16 submodule reference
+        id: postgres-v16-submodule
+        run: |
+            cd vendor/postgres-v16
+            git fetch origin "refs/heads/REL_14_STABLE_neon:refs/heads/origin/REL_14_STABLE_neon"
+            RC=$(git merge-base --is-ancestor origin/REL_14_STABLE_neon HEAD; echo $?)
+            if [ "$RC" != "0" ]; then
+              echo "vendor/postgres-v16 submodule is not an ancestor of the REL_14_STABLE_neon branch. Please rebase it"
+              exit 1
+            fi
+
   check-codestyle-rust:
     needs: [ check-permissions, build-build-tools-image ]
     strategy:
@@ -1152,6 +1201,7 @@ jobs:
     # Usually we do `needs: [...]`
     needs:
       - build-and-test-locally
+      - check-submodules
       - check-codestyle-python
       - check-codestyle-rust
       - promote-images