Add CI job to check graphql schema

.github/workflows/ci.yml

@@ -101,6 +101,45 @@ jobs:
 
       - run: npm run langs:check
 
+  check-graphql:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup project
+        uses: ./.github/actions/setup-project
+        with:
+          CACHE_VERSION: ${{ secrets.CACHE_VERSION }}
+
+      - run: npm run graphql:check
+
+  check-graphql-alt:
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup project
+        uses: ./.github/actions/setup-project
+        with:
+          CACHE_VERSION: ${{ secrets.CACHE_VERSION }}
+
+      - name: Run GraphQL update
+        run: npm run graphql:update
+
+      - name: Check for schema changes
+        run: |
+          if [ -n "$(git status --porcelain)" ]; then
+            echo "Error: GraphQL schema is not up to date. Please update the schema and commit changes." && exit 1
+          else
+            echo "GraphQL schema is up to date."
+          fi
+
   build:
     runs-on: ubuntu-latest
 

package.json

@@ -168,6 +168,7 @@
     "docs:generate:contribution-flow": "tsx ./scripts/docs/contribution-flow.js",
     "git:clean": "cross-env ./scripts/git_clean.sh",
     "graphql:codegen": "graphql-codegen --config scripts/config/graphql-codegen.ts",
+    "graphql:check": "cross-env scripts/check_graphql_schema.sh",
     "graphql:get-schema": "npm-run-all graphql:updateV1 graphql:updateV2",
     "graphql:update": "npm-run-all graphql:updateV1 graphql:updateV2 graphql:codegen",
     "graphql:updateV1": "tsx ./scripts/update-gql-schemas.js http://localhost:3060/graphql/v1 lib/graphql/schema.graphql && prettier lib/graphql/schema.graphql --write",

scripts/check_graphql_schema.sh

@@ -0,0 +1,39 @@
+#!/usr/bin/env bash
+
+set -e
+set -x
+
+# Move to the root directory of the project
+cd -- "$(dirname $0)/.."
+
+# Function to run commands and capture output
+run_and_log() {
+  "$@" 2>&1 | tee /dev/stderr
+  return ${PIPESTATUS[0]}
+}
+
+# Run GraphQL schema update commands and capture the exit status
+EXIT_STATUS=0
+
+run_and_log npm run graphql:updateV1 || EXIT_STATUS=$?
+run_and_log npm run graphql:updateV2 || EXIT_STATUS=$?
+run_and_log npm run graphql:codegen || EXIT_STATUS=$?
+
+# Check if any command failed
+if [ $EXIT_STATUS -ne 0 ]; then
+  echo "Error: One or more commands in graphql:update failed."
+  exit $EXIT_STATUS
+fi
+
+# Check if GraphQL schema files changed
+CHANGED=$(git status --porcelain | grep 'schema')
+if [ -n "${CHANGED}" ] ; then
+  echo "GraphQL schema files are not up to date. Please run 'npm run graphql:update'"
+  echo "-------- FILES --------"
+  git status
+  echo "-------- DIFF --------"
+  git --no-pager diff
+  exit 1
+else
+  echo "GraphQL schema is up to date."
+fi