ci.yml

name: CI

on:
  pull_request:
    branches:
      - main

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}

permissions:
  contents: read
  pull-requests: read
  id-token: write

jobs:
  detect-changes:
    runs-on:
      group: databricks-protected-runner-group
      labels: linux-ubuntu-latest

    name: Detect Changes
    outputs:
      docs: ${{ steps.filter.outputs.docs }}
      appkit: ${{ steps.filter.outputs.appkit }}
    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - uses: dorny/paths-filter@fbd0ab8f3e69293af611ebaee6363fc25e6d187d # v4.0.1
        id: filter
        with:
          filters: |
            docs:
              - 'docs/**'
              - 'packages/**'
            appkit:
              - '!docs/**'

  lint_and_typecheck:
    name: Lint & Type Check
    runs-on:
      group: databricks-protected-runner-group
      labels: linux-ubuntu-latest

    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: Setup JFrog npm
        uses: ./.github/actions/setup-jfrog-npm
      - uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5.0.0
      - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          node-version: 24
          cache: 'pnpm'
      - name: Install dependencies
        run: pnpm install --frozen-lockfile
      - name: Check generated types are up to date
        run: |
          pnpm run generate:types
          if ! git diff --exit-code \
              packages/shared/src/schemas/plugin-manifest.generated.ts \
              packages/appkit/src/registry/types.generated.ts \
              packages/appkit/src/plugins/ga-exports.generated.ts \
              packages/appkit/src/plugins/beta-exports.generated.ts \
              docs/docs/plugins/analytics.md \
              docs/docs/plugins/files.md \
              docs/docs/plugins/genie.md \
              docs/docs/plugins/jobs.md \
              docs/docs/plugins/lakebase.md \
              docs/docs/plugins/model-serving.md \
              docs/docs/plugins/server.md \
              docs/docs/plugins/vector-search.md; then
            echo "❌ Error: Generated files are out of sync with their source manifests/schemas."
            echo ""
            echo "To fix this:"
            echo "  1. Run: pnpm run generate:types"
            echo "  2. Review and commit the changes"
            echo ""
            exit 1
          fi
      - name: Build shared package dist (for sync:template CLI)
        # `pnpm run sync:template` runs through `packages/shared/bin/appkit.js`
        # which imports the built `packages/shared/dist/cli/index.js`. The
        # lint job doesn't otherwise build, so build just shared's dist
        # before invoking sync. We invoke tsdown directly rather than
        # `pnpm --filter shared build:package` because the latter also
        # re-runs `generate-schema-types.ts`, which writes the raw (unformatted)
        # version of `plugin-manifest.generated.ts` and trips the biome
        # check that runs immediately after. ~1s.
        run: pnpm --filter shared exec tsdown --config tsdown.config.ts
      - name: Check synced template manifest is up to date
        run: |
          pnpm run sync:template
          if ! git diff --exit-code template/appkit.plugins.json; then
            echo "❌ Error: template/appkit.plugins.json is out of sync with packages/appkit/src/plugins/<name>/manifest.json."
            echo ""
            echo "This usually happens when a plugin manifest's stability, resources, or display fields"
            echo "are edited without running the sync step that regenerates the template manifest."
            echo ""
            echo "To fix this:"
            echo "  1. Run: pnpm run sync:template"
            echo "  2. Review and commit the changes"
            echo ""
            exit 1
          fi
      - name: Run Biome Check
        run: pnpm run check
      - name: Run Types Check
        run: pnpm run typecheck
      - name: Run Knip Check
        run: pnpm run knip
      - name: Run License Check
        run: pnpm run check:licenses
      - name: Check template deps are pinned
        run: pnpm exec tsx tools/check-template-deps.ts

  test:
    name: Unit Tests
    needs: detect-changes
    if: needs.detect-changes.outputs.appkit == 'true'
    runs-on:
      group: databricks-protected-runner-group
      labels: linux-ubuntu-latest

    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: Setup JFrog npm
        uses: ./.github/actions/setup-jfrog-npm
      - uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5.0.0
      - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          node-version: 24
          cache: 'pnpm'
      - name: Install dependencies
        run: pnpm install --frozen-lockfile
      - name: Run Tests
        run: pnpm test

  playground-integration-test:
    name: Playground Integration Tests
    needs: detect-changes
    if: needs.detect-changes.outputs.appkit == 'true'
    runs-on:
      group: databricks-protected-runner-group
      labels: linux-ubuntu-latest

    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: Setup JFrog npm
        uses: ./.github/actions/setup-jfrog-npm
      - uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5.0.0
      - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          node-version: 24
          cache: 'pnpm'
      - name: Install dependencies
        run: pnpm install --frozen-lockfile
      - name: Install Playwright Browsers
        run: pnpm --filter=dev-playground exec playwright install --with-deps chromium
      - name: Build packages
        run: pnpm build
      - name: Run Integration Tests
        run: pnpm --filter=dev-playground test:integration
        env:
          APPKIT_E2E_TEST: 'true'
          DATABRICKS_WAREHOUSE_ID: e2e-mock
          DATABRICKS_WORKSPACE_ID: e2e-mock

  pr-template-artifact:
    name: PR Template Artifact
    needs: detect-changes
    if: needs.detect-changes.outputs.appkit == 'true'
    runs-on:
      group: databricks-protected-runner-group
      labels: linux-ubuntu-latest

    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: Setup JFrog npm
        uses: ./.github/actions/setup-jfrog-npm
      - uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5.0.0
      - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          node-version: 24
          cache: 'pnpm'
      - name: Install dependencies
        run: pnpm install --frozen-lockfile

      - name: Set PR version
        id: version
        env:
          BRANCH: ${{ github.head_ref }}
        run: |
          SANITIZED_BRANCH=$(echo "$BRANCH" | sed 's/[^a-zA-Z0-9-]/-/g' | sed 's/--*/-/g' | sed 's/^-//;s/-$//')
          CURRENT_VERSION=$(node -p "require('./packages/appkit/package.json').version")
          PR_VERSION="${CURRENT_VERSION}-${SANITIZED_BRANCH}"
          echo "version=$PR_VERSION" >> "$GITHUB_OUTPUT"
          pnpm exec tsx tools/sync-versions.ts "$PR_VERSION"

      - name: Build SDK tarballs
        run: pnpm pack:sdk

      - name: Prepare template artifact
        run: pnpm exec tsx tools/prepare-template-artifact.ts --version "${{ steps.version.outputs.version }}"

      - name: Install template dependencies
        working-directory: pr-template
        run: npm install

      - name: Create zip artifact
        working-directory: pr-template
        run: zip -r ../pr-template.zip . -x 'node_modules/*'

      - name: Upload artifact
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
        with:
          name: appkit-template-${{ steps.version.outputs.version }}
          path: pr-template.zip

  docs-build:
    name: Docs Build
    needs: detect-changes
    if: needs.detect-changes.outputs.docs == 'true'
    runs-on:
      group: databricks-protected-runner-group
      labels: linux-ubuntu-latest

    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
      - name: Setup JFrog npm
        uses: ./.github/actions/setup-jfrog-npm
      - uses: pnpm/action-setup@fc06bc1257f339d1d5d8b3a19a8cae5388b55320 # v5.0.0
      - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          node-version: 24
          cache: 'pnpm'
      - name: Install dependencies
        run: pnpm install --frozen-lockfile
      - name: Build Docs
        run: pnpm run docs:build
      - name: Check Generated Docs
        run: pnpm run docs:check
      - name: Check for uncommitted docs changes
        run: |
          if ! git diff --exit-code docs/docs/api/; then
            echo "❌ Error: Generated docs are out of sync with the codebase."
            echo ""
            echo "The API documentation in docs/docs/api/ has changes after running docs:generate."
            echo "This means the committed docs don't match the current package code."
            echo ""
            echo "To fix this:"
            echo "  1. Run: pnpm docs:build"
            echo "  2. Run: pnpm docs:check:fix"
            echo "  3. Review and commit the changes"
            echo ""
            exit 1
          fi

  devhub-validation:
    name: DevHub Build Validation
    needs: detect-changes
    if: needs.detect-changes.outputs.docs == 'true'
    runs-on:
      group: databricks-protected-runner-group
      labels: linux-ubuntu-latest

    steps:
      - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

      - name: Setup JFrog npm
        uses: ./.github/actions/setup-jfrog-npm

      - name: Clone DevHub
        run: git clone --depth 1 https://github.com/databricks/devhub.git /tmp/devhub

      - uses: actions/setup-node@48b55a011bda9f5d6aeb4c2d9c7362e8dae4041e # v6.4.0
        with:
          node-version: 22

      - name: Install DevHub dependencies
        working-directory: /tmp/devhub
        run: npm install

      - name: Sync AppKit docs from PR branch
        working-directory: /tmp/devhub
        env:
          APPKIT_REMOTE: ${{ github.event.pull_request.head.repo.clone_url || format('https://github.com/{0}.git', github.repository) }}
          APPKIT_BRANCH: ${{ github.head_ref || github.ref_name }}
        run: node scripts/sync-appkit-docs.mjs --force

      - name: Build DevHub
        working-directory: /tmp/devhub
        run: npm run build