From cedd44d105fd5d9225d4653901a8165721d6441e Mon Sep 17 00:00:00 2001
From: Ricky Stewart <ricky@cockroachlabs.com>
Date: Tue, 10 Dec 2024 15:09:23 -0600
Subject: [PATCH] [WIP] ci: check that generated documentation is up-to-date

Closes: #137133

Epic: none
Release note: None
---
 build/github/build.sh | 54 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 54 insertions(+)

diff --git a/build/github/build.sh b/build/github/build.sh
index 71d57a35d6cb..268f355f0fc2 100755
--- a/build/github/build.sh
+++ b/build/github/build.sh
@@ -48,3 +48,57 @@ bazel build \
     //pkg/cmd/cockroach-short //pkg/cmd/cockroach \
     //pkg/cmd/cockroach-sql $GEOS_TARGET $EXTRA_TARGETS
 
+# We don't have to exercise the checks below on every configuration, only
+# bother with Linux.
+if [ "$CONFIG" != "crosslinux" ]
+then
+    exit 0
+fi
+
+BAZEL_BIN=$(bazel info bazel-bin --config "$CONFIG")
+FAILED=
+# Ensure all generated docs are byte-for-byte identical with the checkout.
+for FILE in $(find $BAZEL_BIN/docs -type f)
+do
+    RESULT=$(diff $FILE ${FILE##$BAZEL_BIN/})
+    if [[ ! $? -eq 0 ]]
+    then
+        echo "File $FILE does not match with checked-in version. Got diff:"
+        echo "$RESULT"
+        echo "Run './dev generate docs'"
+        FAILED=1
+    fi
+done
+# Ensure the generated docs are inclusive of what we have in tree: list all
+# generated files in a few subdirectories and make sure they're all in the
+# build output.
+for FILE in $(ls docs/generated/http/*.md | xargs -n1 basename)
+do
+    if [[ ! -f $BAZEL_BIN/docs/generated/http/$FILE ]]
+    then
+        echo "File $BAZEL_BIN/docs/generated/http/$FILE does not exist as a generated artifact. Is docs/generated/http/BUILD.bazel up-to-date?"
+        FAILED=1
+    fi
+done
+for FILE in $(ls docs/generated/sql/*.md | xargs -n1 basename)
+do
+    if [[ ! -f $BAZEL_BIN/docs/generated/sql/$FILE ]]
+    then
+        echo "File $BAZEL_BIN/docs/generated/sql/$FILE does not exist as a generated artifact. Is docs/generated/sql/BUILD.bazel up-to-date?"
+        FAILED=1
+    fi
+done
+for FILE in $(ls docs/generated/sql/bnf/*.bnf | xargs -n1 basename)
+do
+    if [[ ! -f $BAZEL_BIN/docs/generated/sql/bnf/$FILE ]]
+    then
+        echo "File $BAZEL_BIN/docs/generated/sql/bnf/$FILE does not exist as a generated artifact. Is docs/generated/sql/bnf/BUILD.bazel up-to-date?"
+        FAILED=1
+    fi
+done
+
+if [[ ! -z "$FAILED" ]]
+then
+    echo 'Generated files do not match! Are the checked-in generated files up-to-date?'
+    exit 1
+fi