build.yml

name: build
on:
  push:
    branches:
      - main
  pull_request:
    types: [opened, synchronize, reopened, edited]

permissions:
  contents: read

env:
  FORCE_JAVASCRIPT_ACTIONS_TO_NODE24: true

jobs:
  build:
    name: Build
    runs-on: ubuntu-latest
    timeout-minutes: 60
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 100
          persist-credentials: false

      - uses: voidzero-dev/setup-vp@313600b80b104eadebb9111787d37a2e83e014ca # v1.17.0
        with:
          node-version-file: ".node-version"
          cache: true

      - name: Install Dependencies
        run: vp install

      # `vp run -r build` includes @blocknote/xl-typst-compiler, whose build
      # task compiles its Rust wasm when missing or stale (rustup is
      # preinstalled on the runners; the pinned toolchain + wasm32 target
      # auto-provision from rust/rust-toolchain.toml).
      - name: Build packages
        run: vp run -r build

      - name: Lint packages
        run: vp lint

      - name: Run unit tests
        run: vp run test

      - name: Run Next.js integration test (production build)
        run: NEXTJS_TEST_MODE=build vp test run src/unit/nextjs/serverUtil.test.ts
        working-directory: tests

      - name: Upload webpack stats artifact (editor)
        uses: relative-ci/agent-upload-artifact-action@a2b5741b4f7e6a989c84ec1a3059696b23c152e5 # v2
        with:
          webpackStatsFile: ./playground/dist/webpack-stats.json
          artifactName: relative-ci-artifacts-editor

      - name: Soft release
        id: soft-release
        # xl-typst-compiler is excluded: its wasm makes the package ~25MB,
        # which pkg.pr.new rejects (413; multipart uploads are whitelisted -
        # https://github.com/stackblitz-labs/pkg.pr.new/blob/main/.whitelist).
        # Preview installs of the PDF exporter therefore lack the compiler
        # until the repo is whitelisted or the wasm ships separately.
        # TODO disabled only for AI branch--compact
        run: |
          packages=()
          for dir in ./packages/*/; do
            if [[ "$dir" != *"/xl-typst-compiler/"* ]]; then
              packages+=("${dir%/}")
            fi
          done
          vp dlx pkg-pr-new publish "${packages[@]}"

  build-typst-compiler:
    # The one package the e2e suite consumes through build outputs instead of
    # src/ aliases: @blocknote/xl-typst-compiler (its /pkg and /wasm subpaths
    # are wasm build artifacts - see tests/vite.config.browser.ts). Built once
    # on a bare runner - the Playwright container has no C toolchain for the
    # Rust build - and shared with the shards as an artifact.
    name: Build Typst compiler
    runs-on: ubuntu-latest
    timeout-minutes: 30
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 100
          persist-credentials: false

      - uses: voidzero-dev/setup-vp@313600b80b104eadebb9111787d37a2e83e014ca # v1.17.0
        with:
          node-version-file: ".node-version"
          cache: true

      - name: Install dependencies
        run: vp install

      # Compiles the Rust wasm when missing/stale (rustup is bootstrapped by
      # the build task itself) plus the TS wrapper's dist/types.
      - name: Build Typst compiler package
        run: vp run --filter @blocknote/xl-typst-compiler build

      - name: Upload compiler build outputs
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
        with:
          name: typst-compiler-build
          path: |
            packages/xl-typst-compiler/pkg
            packages/xl-typst-compiler/dist
            packages/xl-typst-compiler/types
          include-hidden-files: true

  e2e:
    # Vitest Browser Mode runs in the Playwright Linux container — the same
    # environment as the local Docker run — so behaviour matches local dev.
    # The suite resolves every `@blocknote/*` import to its `src/` via the
    # aliases in `tests/vite.config.browser.ts` (vite transpiles the package
    # sources on the fly), so the packages do NOT need to be built to `dist`
    # first — `vp install` + the checked-out sources are enough (the one
    # exception, xl-typst-compiler, arrives prebuilt from the
    # build-typst-compiler job).
    name: "E2E - ${{ matrix.browser }} (${{ matrix.shardIndex }}/${{ matrix.shardTotal }})"
    runs-on: ubuntu-latest
    timeout-minutes: 30
    needs: build-typst-compiler
    container:
      image: mcr.microsoft.com/playwright:v1.60.0-noble
    strategy:
      fail-fast: false
      matrix:
        browser: [chromium, firefox, webkit]
        shardIndex: [1, 2]
        shardTotal: [2]
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 100
          persist-credentials: false

      - uses: voidzero-dev/setup-vp@313600b80b104eadebb9111787d37a2e83e014ca # v1.17.0
        with:
          node-version-file: ".node-version"
          cache: true

      - name: Install dependencies
        run: vp install

      - name: Download Typst compiler build outputs
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
        with:
          name: typst-compiler-build
          path: packages/xl-typst-compiler

      # No preview server: Vitest Browser Mode serves the tests + mounted example
      # apps itself. `--browser` selects this matrix job's browser and
      # `--shard=<index>/<total>` splits that browser's test files across two
      # parallel machines. Each shard records a machine-readable `blob` report
      # (named per browser+shard so they don't collide); the `merge-reports` job
      # stitches every browser's shards into one HTML report afterwards.
      - name: Run e2e tests (${{ matrix.browser }} ${{ matrix.shardIndex }}/${{ matrix.shardTotal }})
        run: HOME=/root vp test -c vite.config.browser.ts --run --browser ${{ matrix.browser }} --shard=${{ matrix.shardIndex }}/${{ matrix.shardTotal }} --reporter=default --reporter=blob --outputFile.blob=blob-report/blob-${{ matrix.browser }}-${{ matrix.shardIndex }}.json
        working-directory: tests

      - name: Upload blob report (${{ matrix.browser }} ${{ matrix.shardIndex }}/${{ matrix.shardTotal }})
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
        if: ${{ !cancelled() }}
        with:
          name: blob-report-${{ matrix.browser }}-${{ matrix.shardIndex }}
          path: tests/blob-report/
          retention-days: 1

      - name: Upload failure artifacts
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
        if: ${{ failure() }}
        with:
          name: e2e-attachments-${{ matrix.browser }}-${{ matrix.shardIndex }}
          path: tests/.vitest-attachments/
          # The attachments dir is a dot-directory; without this the action
          # silently uploads nothing ("No files were found").
          include-hidden-files: true
          retention-days: 7

  merge-reports:
    # Stitch every browser+shard blob report into a single navigable HTML
    # report (the Vitest equivalent of `playwright merge-reports`). Runs even
    # when a shard failed, so the report always covers every browser.
    name: "E2E Report"
    runs-on: ubuntu-latest
    needs: e2e
    if: ${{ !cancelled() }}
    timeout-minutes: 15
    # Same container as the e2e shards: `--mergeReports` doesn't run tests or
    # launch browsers, but the HTML reporter still resolves the test files'
    # browser environment, so the browser config must stay enabled (and present).
    container:
      image: mcr.microsoft.com/playwright:v1.60.0-noble
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          fetch-depth: 100
          persist-credentials: false

      - uses: voidzero-dev/setup-vp@313600b80b104eadebb9111787d37a2e83e014ca # v1.17.0
        with:
          node-version-file: ".node-version"
          cache: true

      - name: Install dependencies
        run: vp install

      # Gather every shard's blob into one directory (blob-report-chromium-1, …).
      - name: Download blob reports
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
        with:
          path: tests/blob-report
          pattern: blob-report-*
          merge-multiple: true

      # Re-emit a single HTML report from the merged blobs (no tests are run).
      - name: Merge into HTML report
        run: HOME=/root vp test -c vite.config.browser.ts --mergeReports=blob-report --reporter=html
        working-directory: tests

      - name: Upload merged HTML report
        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7
        if: ${{ !cancelled() }}
        with:
          name: e2e-report
          path: tests/playwright-report/
          retention-days: 7

  deploy-report:
    # Publish the merged report to a GitHub Pages PR preview and comment the
    # link on the PR (Vercel-style). Pages serves it over HTTP, so the report's
    # data loads correctly — unlike opening the downloaded artifact over file://
    # (the @vitest/ui report fetches its data and is blocked by CORS there).
    #
    # Default `needs` semantics: this runs only when `merge-reports` succeeded
    # (i.e. a report exists) — but regardless of whether the tests passed, so a
    # red run still gets a navigable preview. Skipped for fork PRs, whose
    # read-only token can't push to gh-pages or comment (they keep the artifact).
    name: "E2E Report Preview"
    runs-on: ubuntu-latest
    needs: merge-reports
    if: ${{ github.event_name == 'pull_request' && github.event.pull_request.head.repo.full_name == github.repository }}
    permissions:
      contents: write
      pull-requests: write
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
        with:
          persist-credentials: false

      - name: Download merged report
        uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8
        with:
          name: e2e-report
          path: e2e-report

      # Deploys to the `gh-pages` branch under `pr-preview/pr-<N>/` and posts a
      # sticky comment with the URL. The companion `pr-preview-cleanup` workflow
      # removes it when the PR closes.
      - name: Deploy report to PR preview
        uses: rossjrw/pr-preview-action@ffa7509e91a3ec8dfc2e5536c4d5c1acdf7a6de9 # v1
        with:
          source-dir: e2e-report
          preview-branch: gh-pages
          umbrella-dir: pr-preview
          action: deploy