test.yml

name: Test

# Runs required test suites before merge. src/tests/SUITES.md explains coverage and merge risk.

on:
  workflow_dispatch:
  merge_group:
  pull_request:

permissions:
  contents: read
  pull-requests: read

# Cancel older test runs for the same ref so newer commits get the runner.
concurrency:
  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
  cancel-in-progress: true

env:
  # ELASTICSEARCH_URL enables Vitest suites that send real search queries.
  ELASTICSEARCH_URL: http://localhost:9200/

jobs:
  test:
    name: ${{ matrix.name }}
    if: github.repository == 'github/docs-internal' || github.repository == 'github/docs'
    runs-on: ubuntu-latest
    timeout-minutes: 60
    strategy:
      fail-fast: false
      matrix:
        # Add new matrix suites to branch protection required checks too.
        name:
          # Lists every src directory. Commented-out entries have no suite-specific tests.
          # - app
          - archives
          - article-api
          - assets
          - audit-logs
          - automated-pipelines
          # - codeql-cli # Enable when the broken scratch test is removed.
          # - codeql-queries
          - color-schemes
          - content-linter
          # - content-pipelines
          - content-render
          - data-directory
          # - deployments
          # - dev-toc
          - early-access
          # - eslint-rules
          - events
          - fixtures
          - frame
          - ghes-releases
          - github-apps
          - graphql
          - journeys
          - landings
          - languages
          - links
          - observability
          # - pages
          - products
          - redirects
          - release-notes
          - rest
          - search
          - secret-scanning
          - shielding
          # - tests
          # - tools
          # - types
          - versions
          - webhooks
          - workflows

        # The languages suite only runs on docs-internal.
        isPrivateRepo:
          - ${{ github.repository == 'github/docs-internal' }}
        exclude:
          - name: languages
            isPrivateRepo: false

    env:
      # These suites make no HTTP requests, so they skip the Next.js build and test server.
      # A suite that adds an HTTP test fails with a connection error until it's removed from this list.
      START_VITEST_SERVER: ${{ contains(fromJSON('["color-schemes", "content-linter", "data-directory", "ghes-releases", "journeys", "links", "observability", "products", "workflows"]'), matrix.name) && 'false' || 'true' }}

    steps:
      # Repeat each if on its step so skipped work still leaves the required check present.
      - name: Check out repo
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          # Fetch 2 commits so tj-actions/changed-files can diff without extra API calls
          fetch-depth: 2

      # Start Elasticsearch early so the pull and boot overlap with setup and build.
      - uses: ./.github/actions/setup-elasticsearch
        if: ${{ matrix.name == 'search' || matrix.name == 'languages' }}
        with:
          mode: start

      - uses: ./.github/actions/node-npm-setup

      - uses: ./.github/actions/get-docs-early-access
        if: ${{ github.repository == 'github/docs-internal' }}
        with:
          token: ${{ secrets.DOCS_BOT_PAT_BASE }}

      - name: Check the test fixture data (if applicable)
        if: ${{ matrix.name == 'fixtures' }}
        run: npm run copy-fixture-data -- --check

      - name: Check the test fixture content (if applicable)
        if: ${{ matrix.name == 'fixtures' }}
        env:
          ROOT: src/fixtures/fixtures
        run: |
          # A failure means fixture content has stale internal links the dry run can update.
          npm run update-internal-links -- --dry-run --check --strict \
            src/fixtures/fixtures/content \
            --exclude src/fixtures/fixtures/content/get-started/foo/typo-autotitling.md \
            --exclude src/fixtures/fixtures/content/get-started/foo/anchor-autotitling.md
          npm run update-internal-links -- --dry-run --check --strict \
            src/fixtures/fixtures/data

      - name: Clone all translations
        if: ${{ matrix.name == 'languages' }}
        uses: ./.github/actions/clone-translations
        with:
          token: ${{ secrets.DOCS_BOT_PAT_BASE }}

      - name: Gather files changed
        if: ${{ matrix.name == 'content-linter' }}
        id: changed_files
        uses: tj-actions/changed-files@22103cc46bda19c2b464ffe86db46df6922fd323 # v47.0.5

      - name: Write changed files to diff file
        if: ${{ matrix.name == 'content-linter' }}
        run: echo "${{ steps.changed_files.outputs.all_modified_files }}" > get_diff_files.txt

      - uses: ./.github/actions/cache-nextjs
        if: ${{ env.START_VITEST_SERVER != 'false' }}

      - name: Run build script
        if: ${{ env.START_VITEST_SERVER != 'false' }}
        run: npm run build

      - uses: ./.github/actions/warmup-remotejson-cache
        # Only routing tests cover archived enterprise server URLs.
        if: ${{ matrix.name == 'redirects' }}

      - uses: ./.github/actions/setup-elasticsearch
        if: ${{ matrix.name == 'search' || matrix.name == 'languages' }}
        with:
          mode: wait

      - name: Index fixtures into the local Elasticsearch
        # Run indexing only for suites that query the local Elasticsearch service.
        if: ${{ matrix.name == 'search' || matrix.name == 'languages' }}
        run: npm run index-test-fixtures

      - name: Run tests
        env:
          DIFF_FILE: get_diff_files.txt
          CHANGELOG_CACHE_FILE_PATH: src/fixtures/fixtures/changelog-feed.json
          # NODE_ENV=test forces English-only tests; the languages suite needs every language.
          ENABLED_LANGUAGES: ${{ matrix.name == 'languages' && 'all' || '' }}
          ROOT: ${{ (matrix.name == 'fixtures' || matrix.name == 'article-api' || matrix.name == 'landings' ) && 'src/fixtures/fixtures' || '' }}
          TRANSLATIONS_FIXTURE_ROOT: ${{ (matrix.name == 'fixtures' || matrix.name == 'article-api') && 'src/fixtures/fixtures/translations' || '' }}
          # RUNNER_DEBUG enables timing and path logs when Actions reruns jobs with debug logging.
          RUNNER_DEBUG: ${{ runner.debug }}
          VITEST_FLAGS: ${{ matrix.name == 'article-api' && '--no-file-parallelism --maxWorkers=1' || '' }}
        run: npm test -- $VITEST_FLAGS src/${{ matrix.name }}/tests/