docusaurus/.github/workflows/argos.yml at main · meta/docusaurus · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
name: Argos CI

on:
  push:
    branches: [main]
  pull_request:
    branches: [main]
    types:
      # Those 3 are the default PR workflow activity types,
      # see https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request
      - opened
      - synchronize
      - reopened
      # We want trigger workflow on labeled too!
      - labeled

permissions:
  contents: read

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

jobs:
  take-screenshots:
    # Argos is heavy to run
    # We only want to trigger Argos on PRs with the 'Argos' label
    # See https://stackoverflow.com/questions/62325286/run-github-actions-when-pull-requests-have-a-specific-label
    if: |
      github.repository == 'meta/docusaurus' &&
      (
        (github.event_name != 'pull_request' && github.ref_name == 'main') ||
        (github.event_name == 'pull_request' && contains(github.event.pull_request.labels.*.name, 'Argos'))
      )
    # runs-on: ubuntu-latest
    runs-on: 8-core-ubuntu
    steps:
      - name: Check out repository code
        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
        uses: actions/setup-node@949feb2413d6458794dcd2491c4babbbce0c15c1 # v7.1.0
        with:
          node-version: lts/*
          check-latest: true
          cache: pnpm

      - name: Install dependencies
        run: pnpm install --frozen-lockfile || pnpm install --frozen-lockfile || pnpm install --frozen-lockfile

      # Playwright is a dependency of the argos workspace package
      # With the pnpm isolated nodeLinker, its binary isn't available at the root
      # Installed in the background, concurrently with the website build
      - name: Install Playwright browsers
        id: playwright-install
        run: pnpm --filter argos exec playwright install --with-deps chromium
        background: true

      - name: Build website for screenshots
        run: pnpm argos:build
      - name: Wait for Playwright browsers
        wait: playwright-install
      - name: Take and upload Argos screenshots
        run: pnpm argos:screenshot

        # We rebuild the site with unminified assets
        # This makes it easier to review text snapshots on Argos
      - name: Build website for text snapshots
        run: pnpm argos:build:text-snapshots
      - name: Format HTML for easier Argos diffs
        run: pnpm argos:format:text-snapshots
      - name: Upload Argos text snapshots
        run: pnpm argos:upload:text-snapshots