Universal-Healthcare/.github/workflows/docs.yml at 84683b8ce011432b81e8f9c86b7a7a74e8db9e48 · mellonedy/Universal-Healthcare · 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:
  push:
    branches: [main]

# Concurrency: cancel in-progress runs on the same PR when a new commit lands.
concurrency:
  group: docs-${{ github.ref }}
  cancel-in-progress: true

jobs:
  docs:
    name: Docs lint + link check
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-node@v4
        with:
          node-version: 18
          cache: pnpm

      - uses: pnpm/action-setup@v4
        with:
          version: 10.6.5

      - run: pnpm install --frozen-lockfile

      - name: Markdownlint (style)
        # Negative globs exclude vendor MD files in installed packages. The
        # config is loaded via --config so the style rules stay self-contained.
        run: |
          pnpm dlx markdownlint-cli2 \
            "**/*.md" \
            "!**/node_modules/**" \
            "!**/.git/**" \
            --config .markdownlint.jsonc

      - name: Markdown link check (cross-links)
        # Scope is intentionally limited to the project docs (docs/**/*.md)
        # + the repo root README; node_modules and other vendor paths are
        # excluded by the glob itself.
        run: |
          pnpm dlx markdown-link-check \
            "docs/**/*.md" \
            "README.md" \
            --config .markdown-link-check.json