glossary/.github/workflows/workflow.yml at 3cd1528917a15755c856113e658c2bcb1671d280 · uk-tre/glossary · 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
# https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions

name: Build
on:
  - push
  - pull_request

jobs:
  lint:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5

      # https://github.com/pre-commit/action
      - uses: pre-commit/action@v3.0.1

  mkdocs:
    runs-on: ubuntu-24.04
    steps:
      - uses: actions/checkout@v4

      - uses: actions/setup-python@v5
        with:
          python-version: "3.13"
          cache: pip
          cache-dependency-path: requirements.txt

      # Cache lychee results to avoid hitting rate limits
      # https://lychee.cli.rs/github_action_recipes/caching/
      - name: Restore lychee cache
        uses: actions/cache@v4
        with:
          path: .lycheecache
          key: cache-lychee-${{ github.sha }}
          restore-keys: cache-lychee-

      - name: Install lychee
        run: |
          LYCHEE_VERSION=0.20.1
          mkdir -p ~/.local/bin
          curl -sfL https://github.com/lycheeverse/lychee/releases/download/lychee-v${LYCHEE_VERSION}/lychee-x86_64-unknown-linux-gnu.tar.gz | tar -zxf - -C ~/.local/bin lychee

      - name: Install dependencies
        run: |
          python -m pip install -r requirements.txt

      - name: Build docs
        run: |
          make build

      - name: Internal link check
        run: |
          make linkcheck-internal

      - name: Full link check
        run: |
          make linkcheck