planwright/.github/workflows/ci-docs.yml at main · steadytao/planwright · 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
name: CI / Docs

on:
  workflow_call:

permissions:
  contents: read

concurrency:
  group: ci-docs-${{ github.event.pull_request.number || github.ref }}
  cancel-in-progress: true

defaults:
  run:
    shell: bash

env:
  CSPELL_VERSION: 10.0.1

jobs:
  docs:
    name: Docs
    runs-on: ubuntu-latest
    timeout-minutes: 15
    steps:
      - name: Harden Runner
        uses: step-security/harden-runner@bf7454d06d71f1098171f2acdf0cd4708d7b5920 # v2.20.0
        with:
          egress-policy: audit
          allowed-endpoints: |
            api.github.com:443
            codeload.github.com:443
            github.com:443
            *.actions.githubusercontent.com:443
            results-receiver.actions.githubusercontent.com:443
            *.blob.core.windows.net:443
            github-releases.githubusercontent.com:443
            objects.githubusercontent.com:443
            objects-origin.githubusercontent.com:443
            github-registry-files.githubusercontent.com:443
            proxy.golang.org:443
            raw.githubusercontent.com:443
            registry.npmjs.org:443
            release-assets.githubusercontent.com:443
            storage.googleapis.com:443
            sum.golang.org:443

      - name: Checkout
        uses: actions/checkout@9c091bb21b7c1c1d1991bb908d89e4e9dddfe3e0 # v7.0.0
        with:
          persist-credentials: false
          fetch-depth: 1

      - name: Setup Go
        uses: actions/setup-go@924ae3a1cded613372ab5595356fb5720e22ba16 # v6.5.0
        with:
          go-version-file: go.mod
          check-latest: false
          cache: true

      - name: Run Planwright Style Check
        run: |
          set -euo pipefail
          go run ./cmd/planwright docs check .

      - name: Run cspell
        run: |
          set -euo pipefail
          npx --yes "cspell@${CSPELL_VERSION}" lint "**/*.md" ".github/**/*.yml" ".github/**/*.yaml" --config .github/config/cspell.json --no-progress --no-summary --no-must-find-files