Pin the link checker to v1 and declare known false positives - #370
Open
mmcky wants to merge 1 commit into
Open
Conversation
✅ Deploy Preview for lustrous-melomakarona-3ee73e ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the repository’s link-checking GitHub Actions workflow to make the external action dependency more stable and to reduce noise from known false-positive link reports.
Changes:
- Pin
QuantEcon/action-link-checkerfrom@mainto the@v1major tag. - Add an
ignore-patternsblock (with explanatory comments) to suppress known false positives, including the previously Sphinx-only ignore list plus FRED timeouts.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| https://doi\.org/10\.1086/262078 | ||
| https://keras\.io/ | ||
| https://data\.oecd\.org/ | ||
| https://fred\.stlouisfed\.org |
Contributor
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 — and only those
The most recent report, #369, lists six broken links, and unlike the sibling repos they are not all noise:
fred.stlouisfed.org(×2)ideas.repec.org/a/bla/jfinan/...python-intro.quantecon.org/optgrowth.html(×2)python.quantecon.org/optgrowth.html#exercisesOnly the two FRED timeouts are suppressed. The four 404s are real HTTP responses from reachable servers, and the three
quantecon.orgones look like genuine rot worth fixing in the source rather than hiding. The workflow carries a comment saying so, so nobody adds them to the list later by reflex.ignore-patternsalso mirrors the five patterns inlectures/_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, so those want closing by hand.