-
Notifications
You must be signed in to change notification settings - Fork 887
chore: check for invalid markdown links in docs weekly #6795
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
We had this before but it was flakey since requests randomly timed out in CI. |
Ok. You can close it. From now on, we can be more careful with links and should test manually before pushing. I can close as not planned. Your call. |
Maybe do this as an actions cron for now? We can probably have it notify a slack channel. |
To post to a slack channel, I will probably need some help from the team. https://github.com/slackapi/slack-github-action |
It turns out that the link check action does not have any outputs, so a workaround will be to follow the steps,
Any other ideas? |
This is a partial solution, as we have to check the output of this workflow every week. I plan to set up slack integration in a separate PR after I find out how to use this action's output instead of saving logs, parsing, and running another workflow to post that to slack. Merging this will at least give us timely reports if there are any invalid links. |
@bpmct suggested posting a message to slack when this workflow runs. We can check the logs on GitHub. |
Can it be merged as it is unharmful and will provide us with useful insights on the docs? @bpmct |
As per #6793, there are multiple broken links in our docs. This action will check if all markdown links are valid.
cc: @ammario @bpmct