Skip to content
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

Automatically check Markdown links #1120

Merged
merged 1 commit into from
Jun 5, 2024
Merged

Automatically check Markdown links #1120

merged 1 commit into from
Jun 5, 2024

Conversation

ehmicky
Copy link
Collaborator

@ehmicky ehmicky commented Jun 5, 2024

Our documentation has lots of links and anchors. It actually takes quite some time to ensure the links are correct. Also, external links might stop working without us knowing.

This adds a GitHub action to automatically check Markdown links, including anchors.

This is hard to believe, but apparently it runs in only 2 seconds. This is written in Rust, but I would expect hundreds of parallel HTTP requests to take longer, but it seems not! :)

This PR currently fails (which is good since it shows the action works) due to the broken links that are fixed in a separate PR at #1119.

@sindresorhus
Copy link
Owner

Failed: Network error: Too Many Requests

Seems to fail with too many requests towards a single host. Seems like the tool should limit concurrency per host to avoid this.

@ehmicky ehmicky force-pushed the link-checker branch 3 times, most recently from 7dea14d to f710eec Compare June 5, 2024 17:35
@ehmicky
Copy link
Collaborator Author

ehmicky commented Jun 5, 2024

There is a max-concurrency option, although it's not per-host. There's also an exclude option. I have added both, and it now seems to work.

@sindresorhus sindresorhus merged commit 4044152 into main Jun 5, 2024
12 checks passed
@sindresorhus sindresorhus deleted the link-checker branch June 5, 2024 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants