schema-compat.yml

# workflows/schema-compat.yml
#
# Schema Compatibility Check
# Validates that the sqlalchemy-paradedb API wrapper stays in sync with the
# ParadeDB SQL schema and that integration tests pass against the new version.
# Triggered automatically on each paradedb release (via repository_dispatch)
# or manually via workflow_dispatch.

name: Schema Compatibility Check

on:
  repository_dispatch:
    types: [paradedb-release]
  workflow_dispatch:
    inputs:
      version:
        description: "ParadeDB version to check against"
        required: true

concurrency:
  group: schema-compat-${{ github.head_ref || github.ref }}
  cancel-in-progress: true

env:
  PARADEDB_VERSION: ${{ inputs.version || github.event.client_payload.version }}

jobs:
  schema-compat:
    name: Check Schema Compatibility
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.13"

      - name: Download pg_search.schema.sql
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          gh release download "v${{ env.PARADEDB_VERSION }}" \
            --repo paradedb/paradedb \
            --pattern pg_search.schema.sql

      - name: Run Schema Compatibility Check
        run: python scripts/check_schema_compat.py pg_search.schema.sql api.json

  integration-tests:
    name: Integration Tests
    runs-on: ubuntu-latest

    services:
      paradedb:
        image: paradedb/paradedb:${{ inputs.version || github.event.client_payload.version }}-pg18
        env:
          POSTGRES_USER: postgres
          POSTGRES_PASSWORD: postgres
          POSTGRES_DB: postgres
        ports:
          - 5432:5432
        options: >-
          --health-cmd "pg_isready -U postgres -d postgres"
          --health-interval 10s
          --health-timeout 5s
          --health-retries 12

    env:
      PARADEDB_TEST_DSN: postgresql+psycopg://postgres:postgres@localhost:5432/postgres
      DATABASE_URL: postgresql+psycopg://postgres:postgres@localhost:5432/postgres
      PGPASSWORD: postgres

    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Set up Python
        uses: actions/setup-python@v6
        with:
          python-version: "3.13"

      - name: Set up uv
        uses: astral-sh/setup-uv@v7
        with:
          enable-cache: true

      - name: Install dependencies
        run: |
          uv venv --python "3.13"
          uv sync --extra test

      - name: Install pg client
        run: sudo apt-get update && sudo apt-get install -y postgresql-client

      - name: Wait for ParadeDB
        run: |
          for i in {1..30}; do
            pg_isready -h localhost -p 5432 -U postgres -d postgres && exit 0
            sleep 2
          done
          echo "ParadeDB did not become ready" >&2
          exit 1

      - name: Run unit tests
        run: uv run --no-sync pytest tests/unit

      - name: Run integration tests
        run: uv run --no-sync pytest -m integration

  notify:
    name: Notify on Failure
    runs-on: ubuntu-latest
    needs: [schema-compat, integration-tests]
    if: failure()
    steps:
      - name: Create GitHub Issue
        env:
          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        run: |
          gh issue create \
            --repo ${{ github.repository }} \
            --title "Schema compat failure for ParadeDB v${{ env.PARADEDB_VERSION }}" \
            --body "$(cat <<EOF
          The schema compatibility check or integration tests failed against ParadeDB **v${{ env.PARADEDB_VERSION }}**.

          **Workflow run:** ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}

          Please investigate and update sqlalchemy-paradedb as needed.
          EOF
          )" \
            --label bug

      - name: Notify Slack on Failure
        run: |
          GITHUB_RUN_URL="${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
          MESSAGE="<!here> \`schema-compat\` workflow failed for ParadeDB v${{ env.PARADEDB_VERSION }} in \`${{ github.repository }}\` -- investigate immediately! GitHub Action Logs: ${GITHUB_RUN_URL}"
          curl -X POST -H 'Content-type: application/json' -d "{\"text\": \"${MESSAGE}\"}" ${{ secrets.SLACK_GITHUB_CHANNEL_WEBHOOK_URL }}