Fix linkcheck GitHub 429 errors #5396
Merged
Conversation
This file contains 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 nonstandard formatting and indentation makes fixing this annoying.
We hit URLs under https://github.com/freedomofpress/securedrop/issues more than GitHub likes, resulting in 429 Too Many Requests errors. These URLs aren't likely to change or go missing, so ignoring them seems a safe way to prevent spurious linkcheck failures. Also increase the number of worker threads checking URLs, to reduce the overall time linkcheck takes.
rmol
requested review from
emkll,
kushaldas,
redshiftzero and
zenmonkeykstop
as code owners
emkll
previously approved these changes
Jul 21, 2020
There was a problem hiding this comment.
lgtm:
- Run make docs-linkcheck and confirm that it does not produce any 429 errors from any URL starting with https://github.com/freedomofpress/securedrop/issues/
zenmonkeykstop
requested changes
Jul 22, 2020
| "https://forum.securedrop.org/admin/users/list/active", | ||
| "https://weblate.securedrop.org/projects/securedrop/securedrop/#repository", | ||
| "https://github.com/freedomofpress/securedrop-debian-packages-lfs", | ||
| r"https://github.com/freedomofpress/securedrop/issues/.*", |
There was a problem hiding this comment.
No 429s for issues tickets, but I did see one for a path on the develop branch:
Warning, treated as error:
/home/user/securedrop/docs/development/tips_and_tricks.rst.rst:134:broken link: https://github.com/freedomofpress/securedrop/tree/develop/docs/diagrams (429 Client Error: too many requests for url: https://github.com/freedomofpress/securedrop/tree/develop/docs/diagrams)
It might be worth adding https://github.com/freedomofpress/securedrop/tree/.* to the list.
There was a problem hiding this comment.
Looks good, passing for me locally now
zenmonkeykstop
approved these changes
Jul 22, 2020
This was referenced Oct 14, 2020
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.
Status
Ready for review
Description of Changes
Sometimes,
make docs-linkcheckcan fail because it hits too many GitHub URLs in a short timeframe and runs afoul of their rate limits. This PR tells the Sphinx linkcheck plugin to ignore anything at https://github.com/freedomofpress/securedrop/issues/ as those URLs are not likely to change or disappear.It also increases the number of linkcheck worker threads in an attempt to reduce the time this check takes.
Testing
Run
make docs-linkcheckand confirm that it does not produce any 429 errors from any URL starting with https://github.com/freedomofpress/securedrop/issues/Deployment
dev only
Checklist
If you made non-trivial code changes: