Skip to content

Replace broken-link action with lychee for external links - #443

Open
s-sajid-ali wants to merge 3 commits into
mainfrom
use-lychee
Open

s-sajid-ali wants to merge 3 commits into
mainfrom
use-lychee

Conversation

@s-sajid-ali

Copy link
Copy Markdown
Member

Summary

  • Removes KaiSpencer/gh-action-check-broken-links. It only checked internal links, which the Docusaurus build already enforces (onBrokenLinks, onBrokenMarkdownLinks, onBrokenMarkdownImages are all "throw"). It also pointed at the old nyu-its.github.io/rts-docs-dev baseUrl.
  • Adds lycheeverse/lychee-action v2.9.0 (pinned to e7477775783ea5526144ba13e8db5eec57747ce8) to check external links in docs/ and blog/ Markdown/MDX. No pnpm, Node or build needed.
  • Runs on PRs to main (reports in the job summary, non-blocking), weekly on Mondays (blocking), and on manual dispatch.
  • actions/checkout is pinned to the v7.0.1 SHA with persist-credentials: false, and the job has contents: read.

Notes

  • No lychee cache for now. It would need an extra actions/cache step to carry over between runs.
  • The first run may turn up dead external links. False positives can go in a .lycheeignore.

🤖 Generated with Claude Code

Internal links are already enforced by the Docusaurus build
(onBrokenLinks: throw), so the KaiSpencer action was redundant and
pointed at a stale baseUrl. lychee checks external URLs in the
Markdown/MDX source on PRs (non-blocking) and weekly (blocking).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

github-actions Bot commented Oct 8, 2026 •

Copy link
Copy Markdown
Contributor
PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://NYU-RTS.github.io/rts-docs/pr-preview/pr-443/

Built to branch gh-pages at 2026-10-08 20:48 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

s-sajid-ali and others added 2 commits October 8, 2026 15:39
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This branch has not been deployed

No deployments
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.

1 participant