Skip to content

ci(workflows): add lychee link checker to docs deployment#60

Merged
johnleider merged 7 commits intomasterfrom
docs/lychee
Jan 8, 2026
Merged

ci(workflows): add lychee link checker to docs deployment#60
johnleider merged 7 commits intomasterfrom
docs/lychee

Conversation

@AndreyYolkin
Copy link
Contributor

@AndreyYolkin AndreyYolkin commented Dec 17, 2025

Add lychee configuration and GitHub action step to check links in docs before deployment.

Beware: It excludes GitHub and Discord URLs from link checking.

@pkg-pr-new
Copy link

pkg-pr-new bot commented Dec 17, 2025

Open in StackBlitz

commit: 8891c81


docs-check:
needs: changes
if: ${{ needs.changes.outputs.docs == 'true' && github.event_name == 'pull_request' }}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

prevent docs-check to run with docs deploy on master

@johnleider
Copy link
Member

Can this also be run locally in addition to CI?

@AndreyYolkin
Copy link
Contributor Author

AndreyYolkin commented Dec 18, 2025

Yes, but this is not an npm package: https://github.com/lycheeverse/lychee#installation. To run it locally, call lychee apps/docs/dist (could be placed in scripts with the name you like)

Add lychee configuration and GitHub action step to check links in docs before deployment. Exclude GitHub URLs from link checking.
Add a new workflow that checks documentation changes in PRs. It runs build and link checking for docs only when docs files are modified, improving CI efficiency by avoiding unnecessary builds.
@johnleider johnleider merged commit 7a22c55 into master Jan 8, 2026
13 checks passed
@johnleider johnleider deleted the docs/lychee branch January 8, 2026 18:45
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.

2 participants