graphix/.github/workflows/doc.yml at master · TeamGraphix/graphix · 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
name: doc

on:
  pull_request:
  workflow_dispatch:

permissions:
  contents: read
  pull-requests: write

concurrency:
  group: ${{ github.workflow }}-${{ github.ref }}
  cancel-in-progress: true

env:
  python-version: "3.14"

jobs:
  check-doc:
    name: "Check documentation"
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5
        with:
          fetch-depth: 0 # Fetch all, necessary to find tags and branches
          fetch-tags: true

      - name: Setup uv
        uses: ./.github/actions/setup-uv
        with:
          enable-cache: true
          python-version: ${{ env.python-version }}

      - name: Make docs
        run: uv run --extra dev --extra doc sphinx-build -W docs/source docs/build -j auto

  lint-text:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5

      - name: Setup uv
        uses: ./.github/actions/setup-uv
        with:
          enable-cache: true

      - name: Run language-agnostic linters
        run: |
          # Non-fixable
          uvx pre-commit run -a check-case-conflict
          uvx pre-commit run -a check-yaml

          # Fixable
          uvx pre-commit run -a end-of-file-fixer || true
          uvx pre-commit run -a fix-byte-order-marker || true
          uvx pre-commit run -a mixed-line-ending || true
          uvx pre-commit run -a trailing-whitespace || true

      - uses: actions/setup-node@v4

      - run: |
          # Pin pnpm to the latest version reported to work
          #
          # CI fails with version 11.0.9:
          # https://github.com/TeamGraphix/graphix/actions/runs/25607609586/job/75172334745
          #
          # CI succeeds with version 10.33.4:
          # https://github.com/TeamGraphix/graphix/actions/runs/25476469782/job/74750924624
          corepack prepare pnpm@10.33.4 --activate
          corepack enable pnpm
          pnpm dlx prettier --write .

      - uses: reviewdog/action-suggester@v1.24.0
        with:
          tool_name: ":art: text-formatter"