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

[CI Docs] Allow linkcheck to retry before declaring link broken #3276

merged 2 commits into from Jan 9, 2020


Copy link

@jack1142 jack1142 commented Jan 6, 2020


  • Bugfix
  • Enhancement
  • New feature

Description of the changes

We all know linkcheck annoyances, this might mitigate our issues with it.

@jack1142 jack1142 requested review from palmtree5 and tekulvw as code owners Jan 6, 2020
@jack1142 jack1142 requested a review from Twentysix26 as a code owner Jan 6, 2020
Copy link

@mikeshardmind mikeshardmind commented Jan 6, 2020

I'm actually a little concerned about this one. Most of the time where we've seen a link check fail was when multiple PRs were being updated at once and we were getting timed out by remote hosts.

Copy link

@Tobotimus Tobotimus commented Jan 7, 2020

So are you saying that this PR would likely make the problem worse..?

Copy link

@mikeshardmind mikeshardmind commented Jan 7, 2020

Probably not worse for us, as it still requires it to fail at least once for anything to be different, but I don't like the idea of this potentially spamming out more requests when the main failure mode we've seen are being timed out by the remote host.

It might be more valuable to not treat the link check as an error, at least if we can get a GH action or other clear notification that allows us to check if a link really does need replacing.

Otherwise, we can still just restart builds which are erroring in known good cases, without losing the current benefits.

I definitely think it's worth addressing, I'm just not sure if this is how we should.

Copy link
Member Author

@jack1142 jack1142 commented Jan 7, 2020

I'm not sure if you can set up recurring link check, but that might be better than doing link check on each PR. It would however be good to also check if any newly added links in PR work (though I don't really know if this can be done sanely)
I don't think it is that bad to do one or two retries for that one link that sometimes may fail if there's high chance that's gonna mitigate the issue but it is true that there are alternatives.

@Flame442 Flame442 added the Type: Enhancement label Jan 8, 2020
Kowlin approved these changes Jan 9, 2020
Copy link

@Kowlin Kowlin left a comment

Looks good.

@Kowlin Kowlin merged commit 83e9391 into Cog-Creators:V3/develop Jan 9, 2020
2 checks passed
@jack1142 jack1142 deleted the patch-1 branch Jan 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Type: Enhancement
None yet

Successfully merging this pull request may close these issues.

None yet

5 participants