Add schema sync check workflow and documentation

- Add check_schema_sync.py to verify generated types match upstream schemas
- Add GitHub Actions workflow to run sync check on PRs
- Update CONTRIBUTING.md with instructions for regenerating types

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

Author: jubrad

.github/workflows/check-schema-sync.yml

@@ -0,0 +1,29 @@
+name: Check Schema Sync
+
+on:
+  merge_group:
+  pull_request:
+    branches: [main]
+  workflow_dispatch:
+
+jobs:
+  check-schema-sync:
+    name: Verify CRD and Helm Schema Sync
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Set up Python
+        run: uv python install 3.12
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Check schema sync
+        run: uv run python scripts/check_schema_sync.py --show-fields

CONTRIBUTING.md

@@ -22,6 +22,24 @@ Pull requests are the best way to propose changes to the codebase. We actively w
 6. Issue that pull request!
 
 
+## Development Setup
+
+This project uses [uv](https://docs.astral.sh/uv/) for Python dependency management. Install uv first:
+
+```bash
+# macOS/Linux
+curl -LsSf https://astral.sh/uv/install.sh | sh
+
+# Or with Homebrew
+brew install uv
+```
+
+Then install the development dependencies:
+
+```bash
+uv sync
+```
+
 ## Generating Documentation
 
 This module uses [terraform-docs](https://terraform-docs.io/user-guide/introduction/) to generate documentation. To generate the documentation, run the following command from the root of the repository:
@@ -30,6 +48,26 @@ This module uses [terraform-docs](https://terraform-docs.io/user-guide/introduct
 .github/scripts/generate-docs.sh
 ```
 
+## Generating Terraform Type Definitions
+
+The Terraform variable type definitions are auto-generated from the upstream Materialize CRD and Helm chart schemas. The version is read from the `environmentd_version` variable default in the source code.
+
+To regenerate:
+
+```bash
+uv run python scripts/generate_terraform_types.py
+```
+
+### Checking Schema Sync
+
+To verify that the generated Terraform types are in sync with upstream schemas:
+
+```bash
+uv run python scripts/check_schema_sync.py
+```
+
+This check runs automatically in CI via the `check-schema-sync` workflow.
+
 ## Development Process
 
 1. Clone the repository

scripts/check_schema_sync.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+"""
+Check that generated Terraform type definitions are in sync with upstream schemas.
+
+Runs the generation script and checks if any files changed.
+
+Exit codes:
+    0: All files in sync
+    1: Files out of sync or uncommitted changes exist
+"""
+
+import subprocess
+import sys
+from pathlib import Path
+
+SCRIPT_DIR = Path(__file__).parent
+REPO_ROOT = SCRIPT_DIR.parent
+
+GENERATED_FILES = [
+    "kubernetes/modules/materialize-instance/crd_variables.gen.tf",
+    "aws/modules/operator/helm_variables.gen.tf",
+    "azure/modules/operator/helm_variables.gen.tf",
+    "gcp/modules/operator/helm_variables.gen.tf",
+    "aws/examples/simple/override_variables.gen.tf",
+    "azure/examples/simple/override_variables.gen.tf",
+    "gcp/examples/simple/override_variables.gen.tf",
+]
+
+
+def main():
+    # Check for uncommitted changes to generated files
+    result = subprocess.run(
+        ["git", "diff", "--name-only", "--"] + GENERATED_FILES,
+        capture_output=True,
+        text=True,
+        cwd=REPO_ROOT,
+    )
+    if result.stdout.strip():
+        print("Error: Uncommitted changes to generated files:", file=sys.stderr)
+        print(result.stdout, file=sys.stderr)
+        sys.exit(1)
+
+    # Run generation
+    print("Running generate_terraform_types.py...")
+    result = subprocess.run(
+        [sys.executable, str(SCRIPT_DIR / "generate_terraform_types.py")],
+        cwd=REPO_ROOT,
+    )
+    if result.returncode != 0:
+        sys.exit(result.returncode)
+
+    # Check for diff
+    result = subprocess.run(
+        ["git", "diff", "--name-only", "--"] + GENERATED_FILES,
+        capture_output=True,
+        text=True,
+        cwd=REPO_ROOT,
+    )
+    if result.stdout.strip():
+        print("\nError: Generated files are out of sync:", file=sys.stderr)
+        print(result.stdout, file=sys.stderr)
+        print(
+            "\nRun 'uv run python scripts/generate_terraform_types.py' to update.",
+            file=sys.stderr,
+        )
+        sys.exit(1)
+
+    print("\nAll generated files are in sync.")
+
+
+if __name__ == "__main__":
+    main()