GitHub Actions: Check URLs using lychee

This makes it possible to be aware of dead links and replace
them with other resources (such as archived versions) as
soon as possible.
This commit is contained in:
Hugo Locurcio
2025-02-17 15:56:09 +01:00
parent fd34a007ba
commit 51a597f7b6
3 changed files with 79 additions and 11 deletions
+38
View File
@@ -0,0 +1,38 @@
name: 🌐 Check URLs
on:
push:
pull_request:
schedule:
# Every day at 18:00 UTC.
# URLs can decay over time. Setting up a schedule makes it possible to be warned
# about dead links as soon as possible.
- cron: "0 18 * * *"
jobs:
check-urls:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- name: Restore lychee cache
uses: actions/cache@v4
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-
- name: Run lychee
uses: lycheeverse/lychee-action@v2
with:
args: >
--base .
--no-progress
--cache
--max-cache-age 1d
--exclude-path _templates/
--exclude-path classes/
"**/*.md" "**/*.html" "**/*.rst"
- name: Fail if there were link errors
run: exit ${{ steps.lc.outputs.exit_code }}