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

linkcheck builder: add a distinct reporting status code for timeouts #11868

Closed
jayaddison opened this issue Jan 10, 2024 · 1 comment · Fixed by #11876
Closed

linkcheck builder: add a distinct reporting status code for timeouts #11868

jayaddison opened this issue Jan 10, 2024 · 1 comment · Fixed by #11876

Comments

@jayaddison
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Currently when the linkcheck builder encounters a timeout while checking a link, the corresponding link will be reported as broken.

This makes it difficult to distinguish between webservers that are slow to respond, as compared to received responses that indicate that a given hyperlink no longer returns useful information. That distinction could be valuable, for example to help determine whether hyperlink unavailability is due to transient or network-related conditions.

Describe the solution you'd like
An additional reporting status for the linkcheck builder. The simplest name for this status would be timeout.

Describe alternatives you've considered
TODO: are there alternatives approaches that would be an improvement on this?

Additional context
Technically the linkcheck builder has (at least) two kinds of timeouts - there's a low-level network socket timeout, which we set to 5 seconds, and there's the per-hyperlink request timeout, relating to the time that the (connected) client will wait for a response from the webserver.

@AA-Turner
Copy link
Member

I think this makes sense.

A

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 13, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants