Validate and update links (STF-557)#1886
Open
oschwald wants to merge 2 commits into
Open
Conversation
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
Adds a lychee configuration and a Links GitHub Actions workflow so that stale or redirecting links are caught automatically going forward. The checker runs on push, pull request, and weekly to catch external link rot. max_redirects is 0 so links that have moved are surfaced and can be updated to their canonical destination. The config is tuned for this Node/TypeScript repo: it scans Markdown, TypeScript sources, and package.json, and excludes generated output (node_modules, dist, build, coverage, docs) and the changelog. lychee is pinned via mise (0.23.0), which is the single source of version truth for both local runs and CI. Part of STF-557. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Validated all links with lychee and updated those that redirected elsewhere to their canonical destinations: - README.md: dev.maxmind.com/minfraud/api-documentation/responses?lang=en#errors -> .../responses/?lang=en#errors (trailing slash before query; was a 308) - README.md: www.maxmind.com/en/support -> support.maxmind.com/knowledge-base (was a 302) - README.dev.md: npmjs.com/package/@maxmind/minfraud-api-node -> www.npmjs.com/package/@maxmind/minfraud-api-node (canonical www form) Also excluded a few false positives in lychee.toml: - dev.maxmind.com/.../responses/#schema-- fragment links: the docs page is client-side rendered, so schema anchors are absent from the static HTML lychee fetches even though the page resolves 200 and the anchor exists in the browser. - http://google.com and www.foobar.com: placeholder/example URLs used as referrer values in test fixtures, not real links. The package.json repository.url (github.com/...minfraud-api-node.git) is the canonical npm git clone URL and is left unchanged. Historical CHANGELOG.md entries are intentionally left unchanged. Part of STF-557. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
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
1 participant
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.
Adds a lychee link-checker configuration and a
LinksGitHub Actions workflow (runs on push, PR, and weekly) so stale or redirecting links are caught automatically going forward. lychee is pinned viamise(0.23.0), the single source of version truth for both local runs and CI; CI installs only lychee viajdx/mise-actionwithinstall: false.The checker scans Markdown, TypeScript sources, and
package.json, withmax_redirects = 0so moved links surface as failures and get updated to their canonical destinations. Generated output (node_modules, dist, build, coverage, docs) and the changelog are excluded.Link updates (old -> new):
README.md:https://dev.maxmind.com/minfraud/api-documentation/responses?lang=en#errors->https://dev.maxmind.com/minfraud/api-documentation/responses/?lang=en#errors(trailing slash before query; was a 308)README.md:https://www.maxmind.com/en/support->https://support.maxmind.com/knowledge-base(was a 302)README.dev.md:https://npmjs.com/package/@maxmind/minfraud-api-node->https://www.npmjs.com/package/@maxmind/minfraud-api-node(canonical www form)False positives excluded in
lychee.toml:dev.maxmind.com/.../responses/#schema--fragment links: the docs page is client-side rendered, so schema anchors are absent from the static HTML lychee fetches even though the page is 200 and the anchor exists in the browser.http://google.com/www.foobar.com: placeholder referrer values in test fixtures, not real links.package.jsongit clone URL, consistent with the GeoIP2-node config.Final lychee run:
12 OK, 0 Errors, 37 Excluded, 1 Unsupported(the unsupported entry is thegit+https://repository URL inpackage.json, which lychee cannot check by scheme).Part of STF-557.
🤖 Generated with Claude Code