Skip to content

Fix markdown-link-check reliability by adding timeout and retry_wait_time configuration #14149

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

Merged
merged 1 commit into from
Jun 28, 2025

Conversation

wl2027
Copy link
Contributor

@wl2027 wl2027 commented Jun 27, 2025

Sometimes when submitting PRs and running markdown-link-check, we encounter unexpected errors even though the links are valid (for example: [markdown-link-check error). Referring to the lychee documentation Lychee Network Error Troubleshooting and Lychee Configuration Documentation, I wonder if we could add two parameters to try to avoid this issue:

  • timeout = 30 (set timeout to 30 seconds)
  • retry_wait_time = 5 (wait 5 seconds between retries)

- timeout = 30 (set timeout to 30 seconds)
- retry_wait_time = 5 (wait 5 seconds between retries)
@wl2027 wl2027 requested a review from a team as a code owner June 27, 2025 15:37
Copy link
Member

@trask trask left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, let's give it a try ❤️

@trask trask merged commit 236f2fb into open-telemetry:main Jun 28, 2025
89 checks passed
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.

2 participants