Description
This is a follow-up of #727 and related to #681. Since make linkcheck
is somewhat unreliable and can't be required for regular PR, the idea is to use a workflow to run it regularly and create (or update) an issue when a link is unreachable. Note that make linkcheck
is already run for PRs, but the result is only visible by looking at the logs.
@AlexWaygood shared a similar workflow in #727 (comment):
Over at typeshed, we have a test that runs every night. If it fails, a bot auto-creates an issue for us. It works pretty well!
Here's the .yml file: https://github.com/python/typeshed/blob/master/.github/workflows/daily.yml
And here's an example of an issue that the bot auto-created when the test failed: python/typeshed#7572
This workflow creates a new issue every time, and it might be ok if it's run weekly/monthly however -- if we want to run it more frequently -- updating an existing issue might be a better approach.
@hugovk also raised a concern in #727 (comment)
One concern: if the cron is often failing (which it might, and often), we don't want it to show the repo as failed at the top:
If this sounds useful we can agree on the details, fix the currently broken links, and adapt the workflow linked above.