Pin the link checker to v1 and declare known false positives - #813
Open
mmcky wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for taupe-gaufre-c4e660 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR hardens and de-noises the documentation link-check workflow by pinning the link-checker action to the stable v1 major line and configuring it to ignore known, recurring false positives (notably FRED timeouts from GitHub-hosted runners).
Changes:
- Pin
QuantEcon/action-link-checkerfrom@mainto@v1to avoid unreviewed behavior changes. - Add
ignore-patternsto exempt known false-positive URL patterns (mirroringlectures/_config.yml’slinkcheck_ignoreintent and avoiding runner-specific FRED timeouts).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Two changes to
linkcheck.yml, following the v1.1.0 release of the link checker.Pin
@main→@v1@maintracks whatever lands on the action's default branch, so this workflow absorbs behaviour changes without review.@v1is a moving tag that follows the 1.x line.Declare the known false positives
The five open "Broken Links Found in Documentation" issues here all report the same thing. The most recent, #810, lists six broken links and every one is
Status: 0 (Timeout)— five FRED URLs and onegithub.comcommit link. None is actually broken; FRED throttles datacenter IP ranges, so it times out from a runner while serving readers normally.Five of the six are handled by the new
ignore-patternsinput, added here. The sixth needs nothing: v1.1.0 fixed a bug where the allowance for well-known hosts required the error stringConnection Errorand so could never fire on a timeout — with that fixed, thegithub.comtimeout is absorbed automatically. I confirmed both against the checker.The list also mirrors the three patterns in
lectures/_config.yml, which Sphinx reads and this checker never sees. A comment records that the two lists have to be kept in step.Existing issues
v1.1.0 stops the weekly duplicates: a recurring finding now refreshes one open issue rather than opening a new one. It does not close the five that already exist — the reuse logic latches onto the newest open issue and leaves older ones alone — so those want closing by hand.