Skip to content

Conversation

@cnaples79
Copy link

@cnaples79 cnaples79 commented Jan 15, 2026

Summary

  • add a GitHub Actions workflow to run lychee for broken-link checks on docs/content changes
  • schedule a weekly run and allow manual dispatch

Rationale

Automated link checking helps catch broken links early without relying on manual checks.

Changes

  • new GH action using lycheeverse/lychee-action with PR/scheduled/manual triggers

Test Plan

  • not run (workflow addition only)

Fixes #134

Copy link
Member

@dlebauer dlebauer left a comment

Choose a reason for hiding this comment

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

@cnaples79 thanks for this contribution! I added a few components from the version in the SIPNET repository. Need to confirm that this works before merging; feel free to remove problematic args that I suggested.

- name: Run lychee
uses: lycheeverse/lychee-action@v1.10.0
with:
args: "--verbose --no-progress --exclude-mail"
Copy link
Member

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

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.

with:
args: "--verbose --no-progress --exclude-mail"
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Copy link
Member

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

Copy link
Member

@dlebauer dlebauer left a comment

Choose a reason for hiding this comment

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

@cnaples79 I ran the workflow (without my suggestions) and it passed. But we have three current issues open that reported broken links: #60, #136, and #137.

Do you know why this would be or what the fix would be?

This PR should fix those broken link issues and close #135

Thanks again for your help with this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add lychee GitHub action to automatically check for broken links

2 participants