Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions .github/workflows/link-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Link Check

on:
push:
branches: [main]
pull_request:
branches: [main]
schedule:
- cron: '0 0 * * *' # Daily at midnight

jobs:
link-checker:
name: Link Checker
runs-on: ubuntu-latest
permissions:
issues: write # Required for creating issues from file
steps:
- uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 22

- name: Install dependencies
run: npm ci

- name: Build site
run: npm run build

- name: Link Checker
id: lychee
uses: lycheeverse/lychee-action@v2
with:
# Check all files in the built site
args: |
.vitepress/dist
--root-dir .vitepress/dist
--include-mail=false
--exclude "^file://"
--accept '200..=299,403'
# Don't fail action on broken links (we'll create an issue instead)
fail: false
# Output format
format: markdown
# Output file path
output: lychee/out.md

- name: Create Issue From File
if: steps.lychee.outputs.exit_code != 0
uses: peter-evans/create-issue-from-file@v5
with:
title: Link Checker Report
content-filepath: ./lychee/out.md
labels: report, automated issue
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
"format": "prettier --write \"**/*.{js,jsx,json,md}\"",
"format:check": "prettier --check \"**/*.{js,jsx,json,md}\"",
"lint": "eslint .vitepress/config.mjs",
"lint:fix": "eslint .vitepress/config.mjs --fix"
"lint:fix": "eslint .vitepress/config.mjs --fix",
"lint:links": "./scripts/link-check.sh"
},
"lint-staged": {
"*.js": [
Expand Down
9 changes: 9 additions & 0 deletions scripts/link-check.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
#!/bin/bash
set -e

echo "Running lychee link check on dist folder..."
lychee .vitepress/dist \
--root-dir .vitepress/dist \
--include-mail=false \
--exclude "^file://" \
--accept '200..=299,403'
Loading