Skip to content

Add lychee link checker #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cnaples79 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add lychee link checker #135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b6652b6
Add lychee link checker workflow
cnaples79 Jan 14, 2026
cf1a832
Another trivial change to trigger deployment
dlebauer Jan 21, 2026
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
30 changes: 30 additions & 0 deletions .github/workflows/link-check.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: Link Check

on:
pull_request:
paths:
- '**/*.md'
- '**/*.mdx'
- '**/*.html'
- 'docs/**'
- 'blog/**'
- 'static/**'
- 'docusaurus.config.js'
- 'sidebars.js'
schedule:
- cron: '0 3 * * 1'
workflow_dispatch:

jobs:
lychee:
name: Check links with lychee
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
- name: Run lychee
uses: lycheeverse/lychee-action@v1.10.0
with:
args: "--verbose --no-progress --exclude-mail"
Copy link
Member

@dlebauer dlebauer Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These settings were helpful in the SIPNET link checker

Suggested change
args: "--verbose --no-progress --exclude-mail"
args: >-
--verbose --no-progress --exclude-mail
--include-fragments
--no-progress
--verbose
--timeout 20
--max-redirects 10
--max-retries 3
--retry-wait-time 2
--format markdown
--exclude '^https://doi\.org/'
.
fail: true

Copy link
Member

@dlebauer dlebauer Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove --include-fragments initially (or add exclusions). if problematic.

env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Copy link
Member

@dlebauer dlebauer Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Upload lychee report
if: ${{ always() }}
uses: actions/upload-artifact@v4
with:
name: lychee-report
path: lychee

1 change: 0 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,6 @@ tags: [gsoc, gsoc21]
---
```


<!-- These screenshots are large and don't appear to be in the right place, if necessary
## Screenshots

Expand Down