Implement link validator and update gitignore for caching - #45
Open
Amaru333 wants to merge 10 commits into
Open
Conversation
mbwatson
requested changes
Aug 18, 2026
mbwatson
left a comment
Member
There was a problem hiding this comment.
a nice improvement overall, especially keeping link checks non-blocking so they report issues and don't block releases
we may modify on.push to push: { branches: ['**'] } to not fire on tag pushes, which is likely in our future.
could we add a short note in README.md about local Lychee installation prerequisites for the new links:* scripts? Right now scripts/check-links.mjs invokes Lychee directly, so devs may hit a "command not found" error. a brief "install Lychee + verify with lychee --version" note for Mac and Linux could help smooth things out.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces automated link checking to the CI workflow, improves link validation tooling, and adds scripts for easier local and CI-based link checks across all app workspaces. The changes ensure that both internal and external links are validated regularly, and provide developers with convenient scripts to run these checks locally.
CI/CD and Workflow Enhancements:
.github/workflows/ci.yaml, including detection of changed apps, internal link checks for all apps, and external link checks forsiteandconsortium. This ensures broken links are caught both on PRs and on a weekly schedule. [1] [2]lintjob to only run on relevant events, optimizing workflow runs.Developer Tooling and Scripts:
scripts/check-links.mjsthat builds each app and runs the Lychee link checker in offline, online, or unique-link modes, making it easy to validate links locally or in CI.links:offline,links:online, andlinks:uniquenpm scripts to the rootpackage.jsonand to each app (site,consortium,docs) for running link checks directly via npm. [1] [2] [3] [4]Configuration and Documentation:
lychee.toml) to standardize link checking behavior and exclusions.README.mdto document the new link check in the CI process, clarifying when internal and external links are validated.