puppeteer/.github/workflows/ci.yml

name: CI

# Declare default permissions as read only.
permissions: read-all

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - '**'

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

jobs:
  inspect-code:
    name: Inspect code
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 2
      - name: Set up Node.js
        uses: actions/setup-node@v3.4.1
        with:
          node-version: 18
      - name: Setup cache for Chromium binary
        uses: actions/cache@v3
        with:
          path: .local-chromium
          key: ${{ runner.os }}-chromium-${{ hashFiles('src/revisions.ts') }}
      - name: Install dependencies
        run: npm ci
      - name: Check code
        run: npm run check
      - name: Lint code
        run: npm run lint
      - name: Lint commits
        run: npm run commitlint
        if: github.event_name != 'pull_request'

  check-docs:
    name: Check documentation
    runs-on: ubuntu-latest
    outputs:
      needs_deploying: ${{ steps.needs_deploying.outputs.value }}
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 2
      - name: Set up Node.js
        uses: actions/setup-node@v3.4.1
        with:
          cache: npm
      - name: Setup cache for Chromium binary
        uses: actions/cache@v3
        with:
          path: .local-chromium
          key: ${{ runner.os }}-chromium-${{ hashFiles('src/revisions.ts') }}
      - name: Install dependencies
        run: npm ci
      - name: Build
        run: npm run docs
      - name: Check if autogenerated docs differ
        run: |
          diff_file=$(mktemp doc_diff_XXXXXX)
          git diff --color > $diff_file
          if [[ -s $diff_file ]]; then
            echo "Please update the documentation by running 'npm run docs'. The following was the diff"
            cat $diff_file
            rm $diff_file
            exit 1
          fi
          rm $diff_file
      - name: Check if docs need to be deployed
        id: needs_deploying
        run: |
          if [[ $(git diff HEAD^ -- ./docs ./website) ]]; then
            needs_deploying=true
          else
            needs_deploying=false
          fi
          echo "::set-output name=value::$needs_deploying"

  deploy-docs:
    needs: check-docs
    name: Deploy docs (if needed)
    if: ${{ needs.check-docs.outputs.needs_deploying == 'true' && github.event_name != 'pull_request' }}
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Set up Node.js
        uses: actions/setup-node@v3.4.1
        with:
          cache: npm
      - name: Install dependencies
        working-directory: ./website
        run: npm ci
      - name: Build website
        working-directory: ./website
        env:
          NODE_OPTIONS: --max-old-space-size=6144
        run: npm run build
      - name: Deploy to GitHub Pages
        uses: peaceiris/actions-gh-pages@v3
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}
          publish_dir: ./website/build
          user_name: release-please[bot]
          user_email: 55107282+release-please[bot]@users.noreply.github.com

  tests:
    name: ${{ matrix.spec.name }} tests on ${{ matrix.spec.machine }}(${{ matrix.spec.node }})
    runs-on: ${{ matrix.spec.machine }}
    strategy:
      matrix:
        spec:
          - name: chrome-headless
            machine: ubuntu-latest
            xvfb: true
            node: 14
            suite: chrome-headless
          - name: chrome-headless
            machine: ubuntu-latest
            xvfb: true
            node: 16
            suite: chrome-headless
          - name: chrome-headless
            machine: ubuntu-latest
            xvfb: true
            node: 18
            suite: chrome-headless
          - name: chrome-headless
            machine: windows-latest
            xvfb: false
            node: 18
            suite: chrome-headless
          - name: chrome-headless
            machine: macos-latest
            xvfb: false
            node: 18
            suite: chrome-headless
          - name: chrome-headful
            machine: ubuntu-latest
            xvfb: true
            node: 14
            suite: chrome-headful
          - name: chrome-headful
            machine: ubuntu-latest
            xvfb: true
            node: 16
            suite: chrome-headful
          - name: chrome-headful
            machine: ubuntu-latest
            xvfb: true
            node: 18
            suite: chrome-headful
          - name: chrome-new-headless
            machine: ubuntu-latest
            xvfb: true
            node: 14
            suite: chrome-new-headless
          - name: chrome-new-headless
            machine: ubuntu-latest
            xvfb: true
            node: 16
            suite: chrome-new-headless
          - name: chrome-new-headless
            machine: ubuntu-latest
            xvfb: true
            node: 18
            suite: chrome-new-headless
          - name: firefox-headless
            machine: ubuntu-latest
            xvfb: true
            node: 14
            suite: firefox-headless
          - name: firefox-headless
            machine: ubuntu-latest
            xvfb: true
            node: 16
            suite: firefox-headless
          - name: firefox-headless
            machine: ubuntu-latest
            xvfb: true
            node: 18
            suite: firefox-headless
          - name: firefox-headful
            machine: ubuntu-latest
            xvfb: true
            node: 16
            suite: firefox-headful
          - name: firefox-headful
            machine: ubuntu-latest
            xvfb: true
            node: 18
            suite: firefox-headful
          - name: firefox-bidi
            machine: ubuntu-latest
            xvfb: true
            node: 18
            suite: firefox-bidi

    steps:
      - name: Checkout
        uses: actions/checkout@v3
      - name: Setup cache for Chromium binary
        uses: actions/cache@v3
        with:
          path: .local-chromium
          key: ${{ runner.os }}-chromium-${{ hashFiles('src/revisions.ts') }}
      - name: Setup cache for Firefox binary
        uses: actions/cache@v3
        with:
          path: .local-firefox
          key: ${{ runner.os }}-firefox-${{ hashFiles('src/revisions.ts') }}
      - name: Set up Node.js
        uses: actions/setup-node@v3.4.1
        with:
          node-version: ${{ matrix.spec.node }}
      - name: Install dependencies with Chromium
        run: npm install
      - name: Install Firefox
        env:
          PUPPETEER_PRODUCT: firefox
        run: npm install
      - name: Install linux dependencies.
        if: ${{ matrix.spec.xvfb }}
        run: sudo apt-get install xvfb
      - name: Build
        run: npm run build:dev
      - name: Test types
        run: npm run test:types
      - name: Run all tests with xvfb
        if: ${{ matrix.spec.xvfb }}
        run: xvfb-run --auto-servernum npm run test -- --test-suite ${{ matrix.spec.suite }}
      - name: Run all tests without xvfb
        if: ${{ !matrix.spec.xvfb }}
        run: npm run test -- --test-suite ${{ matrix.spec.suite }}
      - name: Test bundling and installation
        if: ${{ matrix.spec.machine == 'ubuntu-latest' }}
        run: |
          # Test prod build instead of dev.
          npm run clean
          npm run build
          # Note: this modifies package.json to test puppeteer-core, so we test this last.
          npm run test:install

  docker-tests:
    runs-on: ${{ matrix.os }}
    strategy:
      matrix:
        os: [ubuntu-latest]
        node: [16]
    steps:
      - name: Checkout
        uses: actions/checkout@v3
        with:
          fetch-depth: 2
      - name: Set up Node.js
        uses: actions/setup-node@v3.4.1
        with:
          node-version: ${{ matrix.node }}
      - name: Install dependencies
        run: |
          npm install
          ls .local-chromium
      - name: Build
        run: |
          npm run build
          docker/pack.sh
      - name: Build docker image
        working-directory: ./docker
        run: |
          docker build -t puppeteer-test-image .
      - name: Run smoke test
        working-directory: ./docker
        run: |
          docker run -i --init --cap-add=SYS_ADMIN --rm puppeteer-test-image node -e "`cat test/smoke-test.js`"