chore: Adds dead link checker and associated automation #70
Conversation
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
steve-calvert-glean
changed the title
|
We should hold off on merging this until we've fixed the outstanding broken links. 🔍 14997 Total (in 30s) ✅ 13666 OK 🚫 14 Errors 👻 1317 Excluded |
aureliawang-glean
approved these changes
Jul 17, 2025
|
@steve-calvert-glean - Still want to do this? Should one of us pick up and try to resolve those broken links? |
|
Yes. This was just waiting to fix all those broken links, but we should for sure land this. |
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 a new GitHub Actions workflow for automated link checking, updates the
scripts/check-links.shscript to support configurable checks, and adds a new npm script to simplify local link verification. These changes aim to improve the reliability of documentation links and streamline link-checking processes.GitHub Actions Workflow for Link Checking:
.github/workflows/link-checker.ymlto automate link checking. It supports both scheduled and manual runs, with configurable options for "quick" or "deep" checks and a customizable base URL. The workflow uses thelycheetool to validate links and creates GitHub issues for broken links detected during scheduled runs.Enhancements to Link-Checking Script:
scripts/check-links.shto accept a base URL and a "deep check" flag as arguments, enabling more flexible usage. The script now builds a dynamiclycheecommand with exclusions for known problematic URLs, localhost, and external API endpoints. It also supports deep content crawling when the "deep check" flag is enabled. [1] [2]New NPM Script for Local Link Checking:
links:checkinpackage.jsonto run the link-checking script locally with a deep check on the default base URL (https://developers.glean.com).