docs/.github/workflows/links.yml at main · tempoxyz/docs · 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
name: External Links

on:
  push:
    branches: [main]
  pull_request:
  schedule:
    # Weekly link-rot check, independent of code changes.
    - cron: "0 9 * * 1"
  workflow_dispatch:

permissions: {}

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

jobs:
  lychee:
    name: Lychee
    runs-on: ubuntu-latest
    timeout-minutes: 10
    permissions:
      contents: read
      id-token: write
      issues: write

    steps:
      - name: Secure runner
        uses: tempoxyz/gh-actions/actions/secure-runner@55fe3b63d9612623cc51e6c62d9d62fbcb175fb0 # 2026-09-29T01-25-15Z-55fe3b63

      - name: Clone repository
        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
        with:
          persist-credentials: false

      - name: Setup Node.js
        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
        with:
          node-version: 24.12.0

      - name: Restore lychee cache
        uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0
        with:
          path: .lycheecache
          key: lychee-${{ github.sha }}
          restore-keys: lychee-

      - name: Run lychee
        uses: tempoxyz/gh-actions/vendor/lycheeverse/lychee-action@55fe3b63d9612623cc51e6c62d9d62fbcb175fb0 # 2026-09-29T01-25-15Z-55fe3b63
        with:
          # README.md is a GitHub-only artifact with pre-existing
          # broken references (LICENSE files, lockup paths); excluded
          # from this check. Docs site content lives in src/pages/.
          args: >-
            --preprocess scripts/filter-external-links.ts
            'src/pages/**/*.md'
            'src/pages/**/*.mdx'
            'vocs.config.ts'
          fail: ${{ github.event_name == 'pull_request' || github.event_name == 'push' }}
          token: ${{ secrets.GITHUB_TOKEN }}

      - name: Open issue on scheduled failure
        if: failure() && github.event_name == 'schedule'
        env:
          GH_TOKEN: ${{ github.token }}
        run: gh issue create --title "Broken external links detected" --body-file lychee/out.md --label docs --label links