tests-e2e.yml

name: E2E Tests

on:
  push:
    branches:
      - main
      - docusaurus-v**
    paths:
      - package.json
      - pnpm-lock.yaml
      - vitest.config.ts
      - test/**
      - packages/**
      - tsconfig.*.json
  pull_request:
    branches:
      - main
      - docusaurus-v**
    paths:
      - package.json
      - pnpm-lock.yaml
      - vitest.config.ts
      - test/**
      - packages/**
      - tsconfig.*.json
      - admin/verdaccio.yaml
      - admin/scripts/test-release.sh
      - .github/workflows/tests-e2e.yml

concurrency:
  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
  cancel-in-progress: true

permissions:
  contents: read

jobs:
  # e2e tests running on Windows
  e2e-windows:
    name: E2E — Windows
    timeout-minutes: 30
    runs-on: windows-8-core
    steps:
      - name: Checkout
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
      - name: Install pnpm
        uses: pnpm/setup@fa36a5ef7dcdefc3a7cb25655c122e00cf6e636e # v3.1.2
        with:
          # Only install pnpm: Node.js and dependencies are installed by later steps
          install: false
          node-version-file: false
      - name: Use Node.js LTS
        uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
        with:
          node-version: lts/*
          check-latest: true
          # No pnpm cache on Windows on purpose: restoring it takes 20-80s,
          # more than it saves on "pnpm install"
          package-manager-cache: false
      - name: Installation
        run: pnpm install --frozen-lockfile || pnpm install --frozen-lockfile || pnpm install --frozen-lockfile
      - name: Generate test-website project against main branch
        # Not using test-release.sh => no verdaccio docker image on Windows
        # We have to generate the test website in workspace so that it uses
        # current packages as dependencies instead of deps from npm
        run: node ./packages/create-docusaurus/bin/index.js test-website-in-workspace classic --typescript
      - name: Install test-website-in-workspace project
        run: pnpm install --no-frozen-lockfile --ignore-scripts || pnpm install --no-frozen-lockfile --ignore-scripts || pnpm install --no-frozen-lockfile --ignore-scripts
        working-directory: test-website-in-workspace
      - name: Start test-website-in-workspace project
        run: pnpm start --no-open
        working-directory: test-website-in-workspace
        env:
          E2E_TEST: true
      - name: Build test-website-in-workspace project
        # We build 2 locales to ensure a localized site doesn't leak memory
        # See https://github.com/facebook/docusaurus/issues/10944
        run: pnpm build --locale en --locale fr
        env:
          # Our website should build even with limited memory
          # See https://github.com/facebook/docusaurus/pull/10590
          NODE_OPTIONS: '--max-old-space-size=200'
          DOCUSAURUS_PERF_LOGGER: 'true'
        working-directory: test-website-in-workspace
      # Upload build artifacts to ease Windows-specific troubleshooting
      - name: Upload website artifact
        uses: actions/upload-artifact@cf430e030ddbb5b0abf93d22962f4752f3646cd9 # v7.0.2
        with:
          name: website-e2e-windows
          path: test-website-in-workspace/build
          if-no-files-found: error
      - name: TypeCheck website
        working-directory: test-website-in-workspace
        run: pnpm typecheck

  yarn-v1:
    name: E2E — Yarn v1
    timeout-minutes: 30
    runs-on: ubuntu-latest
    strategy:
      matrix:
        node: ['26.13', '26']
    steps:
      - name: Checkout
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
      - name: Install pnpm
        uses: pnpm/setup@fa36a5ef7dcdefc3a7cb25655c122e00cf6e636e # v3.1.2
        with:
          # Only install pnpm: Node.js and dependencies are installed by later steps
          install: false
          node-version-file: false
      - name: Use Node.js ${{ matrix.node }}
        uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
        with:
          node-version: ${{ matrix.node }}
          cache: pnpm
      - name: Installation
        run: pnpm install --frozen-lockfile || pnpm install --frozen-lockfile || pnpm install --frozen-lockfile
      - name: Generate test-website project against main branch
        run: pnpm test:build:website -s
      - name: Install test-website project with Yarn v1
        run: yarn install --frozen-lockfile || yarn install --frozen-lockfile || yarn install --frozen-lockfile
        working-directory: ../test-website
        env:
          npm_config_registry: http://localhost:4873
      - name: Start test-website project
        run: yarn start --no-open
        working-directory: ../test-website
        env:
          E2E_TEST: true
      - name: Build test-website project
        # We build 2 locales to ensure a localized site doesn't leak memory
        # See https://github.com/facebook/docusaurus/issues/10944
        run: yarn build --locale en --locale fr
        env:
          # Our website should build even with limited memory
          # See https://github.com/facebook/docusaurus/pull/10590
          NODE_OPTIONS: '--max-old-space-size=200'
          DOCUSAURUS_PERF_LOGGER: 'true'
        working-directory: ../test-website

  yarn-berry:
    name: E2E — Yarn Berry
    timeout-minutes: 30
    runs-on: ubuntu-latest
    strategy:
      matrix:
        nodeLinker: [pnp, node-modules]
        variant: [-s, -st]
    steps:
      - name: Checkout
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
      - name: Install pnpm
        uses: pnpm/setup@fa36a5ef7dcdefc3a7cb25655c122e00cf6e636e # v3.1.2
        with:
          # Only install pnpm: Node.js and dependencies are installed by later steps
          install: false
          node-version-file: false
      - name: Use Node.js LTS
        uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
        with:
          node-version: lts/*
          check-latest: true
          cache: pnpm
      - name: Installation
        run: pnpm install --frozen-lockfile || pnpm install --frozen-lockfile || pnpm install --frozen-lockfile
      - name: Generate test-website project with ${{ matrix.variant }} against main branch
        run: pnpm test:build:website ${{ matrix.variant }}
      - name: Install test-website project with Yarn Berry and nodeLinker = ${{ matrix.nodeLinker }}
        run: |
          yarn set version berry

          # Disable supply chain cooldown
          # We don't need it in that workflow
          # Our other workflows already have cooldown checks!
          yarn config set npmMinimalAgeGate 0
          yarn config get npmMinimalAgeGate --why
          yarn config set npmMinimalAgeGate 0

          yarn config set nodeLinker ${{ matrix.nodeLinker }}
          yarn config set npmRegistryServer http://localhost:4873
          yarn config set unsafeHttpWhitelist --json '["localhost"]'
          yarn config set enableGlobalCache true
          yarn config set npmPreapprovedPackages --json '["@docusaurus/*"]'

          # Make PnP as strict as possible
          # https://yarnpkg.com/features/pnp#fallback-mode
          yarn config set pnpFallbackMode none

          yarn || yarn || yarn
        working-directory: ../test-website
        env:
          YARN_ENABLE_IMMUTABLE_INSTALLS: false # Yarn berry should create the lockfile, despite CI env
      - name: Start test-website project
        run: yarn start --no-open
        working-directory: ../test-website
        env:
          E2E_TEST: true

      - name: TypeCheck website
        # TODO: there're some lingering issues with PnP + tsc. Enable tsc in PnP later.
        if: matrix.variant == '-st' && matrix.nodeLinker != 'pnp'
        working-directory: ../test-website
        run: yarn typecheck

      - name: TypeCheck website - min version - v6.0
        # TODO: there're some lingering issues with PnP + tsc. Enable tsc in PnP later.
        if: matrix.variant == '-st' && matrix.nodeLinker != 'pnp'
        working-directory: ../test-website
        run: |
          yarn add typescript@6.0 --exact
          yarn typecheck
      - name: TypeCheck website - max version - Latest
        # TODO: there're some lingering issues with PnP + tsc. Enable tsc in PnP later.
        if: matrix.variant == '-st' && matrix.nodeLinker != 'pnp'
        working-directory: ../test-website
        run: |
          yarn add typescript@latest --exact
          yarn typecheck

      - name: Build test-website project
        # We build 2 locales to ensure a localized site doesn't leak memory
        # See https://github.com/facebook/docusaurus/issues/10944
        run: yarn build --locale en --locale fr
        env:
          # Our website should build even with limited memory
          # See https://github.com/facebook/docusaurus/pull/10590
          NODE_OPTIONS: '--max-old-space-size=200'
          DOCUSAURUS_PERF_LOGGER: 'true'
        working-directory: ../test-website

  npm:
    name: E2E — npm
    timeout-minutes: 30
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
      - name: Install pnpm
        uses: pnpm/setup@fa36a5ef7dcdefc3a7cb25655c122e00cf6e636e # v3.1.2
        with:
          # Only install pnpm: Node.js and dependencies are installed by later steps
          install: false
          node-version-file: false
      - name: Use Node.js LTS
        uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
        with:
          node-version: lts/*
          check-latest: true
          cache: pnpm
      - name: Installation
        run: pnpm install --frozen-lockfile || pnpm install --frozen-lockfile || pnpm install --frozen-lockfile
      - name: Generate test-website project against main branch
        run: pnpm test:build:website -st
      - name: Install test-website project with npm
        run: npm install
        working-directory: ../test-website
        env:
          npm_config_registry: http://localhost:4873
      - name: TypeCheck website
        working-directory: ../test-website
        run: npm run typecheck
      - name: Start test-website project
        run: npm run start -- --no-open
        working-directory: ../test-website
        env:
          E2E_TEST: true
      - name: Build test-website project
        # We build 2 locales to ensure a localized site doesn't leak memory
        # See https://github.com/facebook/docusaurus/issues/10944
        run: npm run build -- --locale en --locale fr
        env:
          # Our website should build even with limited memory
          # See https://github.com/facebook/docusaurus/pull/10590
          NODE_OPTIONS: '--max-old-space-size=200'
          DOCUSAURUS_PERF_LOGGER: 'true'
        working-directory: ../test-website

  pnpm:
    name: E2E — pnpm
    timeout-minutes: 30
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
      - name: Install pnpm
        uses: pnpm/setup@fa36a5ef7dcdefc3a7cb25655c122e00cf6e636e # v3.1.2
        with:
          # Only install pnpm: Node.js and dependencies are installed by later steps
          install: false
          node-version-file: false
      - name: Use Node.js LTS
        uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
        with:
          node-version: lts/*
          check-latest: true
          cache: pnpm
      - name: Installation
        run: pnpm install --frozen-lockfile || pnpm install --frozen-lockfile || pnpm install --frozen-lockfile
      - name: Generate test-website project against main branch
        run: pnpm test:build:website -st
      - name: Install test-website project with pnpm
        run: pnpm install
        working-directory: ../test-website
        env:
          pnpm_config_registry: http://localhost:4873
      - name: TypeCheck website
        working-directory: ../test-website
        run: pnpm run typecheck
      - name: Start test-website project
        run: pnpm start --no-open
        working-directory: ../test-website
        env:
          E2E_TEST: true
      - name: Build test-website project
        # We build 2 locales to ensure a localized site doesn't leak memory
        # See https://github.com/facebook/docusaurus/issues/10944
        run: pnpm run build --locale en --locale fr
        env:
          # Our website should build even with limited memory
          # See https://github.com/facebook/docusaurus/pull/10590
          NODE_OPTIONS: '--max-old-space-size=200'
          DOCUSAURUS_PERF_LOGGER: 'true'
        working-directory: ../test-website