website/.github/workflows/docs.yml at main · decdn/website · 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
name: docs

on:
  pull_request:
    paths:
      - "docs/**"
      - ".github/workflows/docs.yml"
      - ".markdownlint-cli2.jsonc"
      - ".prettierrc.json"
      - ".prettierignore"
      - "package.json"
      - "pnpm-lock.yaml"
  push:
    branches: [main]
    paths:
      - "docs/**"
      - ".github/workflows/docs.yml"
      - ".markdownlint-cli2.jsonc"
      - ".prettierrc.json"
      - ".prettierignore"
      - "package.json"
      - "pnpm-lock.yaml"

permissions:
  contents: read

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
      - uses: pnpm/action-setup@ea17c68df8912ef543352723c149a84f56e3d413 # v6.1.0
      - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0
        with:
          node-version: 24
          cache: pnpm
      - run: pnpm install --frozen-lockfile
      - name: Prettier check
        run: pnpm exec prettier --check "docs/**/*.{md,mdx,json}"
      - name: markdownlint
        run: pnpm exec markdownlint-cli2
      # `website.yml` has `paths-ignore: docs/**`, so a docs-only change never
      # runs the suite there. `docs/canonical-host.js` is the one piece of
      # executable code under `docs/` and it has a test, so run vitest here too.
      - name: Tests
        run: pnpm test
      - name: Mintlify broken-link check
        working-directory: docs
        run: npx -y mintlify@4.2.555 broken-links