progress-platform/.github/workflows/lychee.yml at DEV · ProgressLabIT/progress-platform · 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
# .github/workflows/lychee.yml
name: lychee dead-link check

on:
  pull_request:
    paths:
      - 'docs/**'
      - '.github/workflows/lychee.yml'
      - 'lychee.toml'
  push:
    branches: [DEV]
    paths:
      - 'docs/**'
      - 'lychee.toml'
      - '.github/workflows/lychee.yml'
  workflow_dispatch:

jobs:
  linkChecker:
    runs-on: ubuntu-latest
    timeout-minutes: 10   # L-01: bound runaway link checks
    permissions:
      contents: read
    steps:
      - name: Checkout
        uses: actions/checkout@v5

      - name: lychee link check (source markdown — external URLs only)
        uses: lycheeverse/lychee-action@v2
        with:
          # Scope to source markdown only. VitePress validates internal links
          # at build time; lychee here catches external/dead URLs in prose.
          # Self-referential /progress-platform/... paths are excluded via
          # lychee.toml since they're VitePress build-output artifacts, not
          # author-written links.
          args: >-
            --no-progress
            --include-fragments
            --root-dir "${{ github.workspace }}/docs"
            --exclude-path docs/node_modules
            --exclude-path docs/.vitepress/templates
            --config "${{ github.workspace }}/lychee.toml"
            "docs/**/*.md"
          fail: true
          jobSummary: true