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

Markdownlint extremely flaky #668

Closed
anuraaga opened this issue Jun 24, 2020 · 8 comments
Closed

Markdownlint extremely flaky #668

anuraaga opened this issue Jun 24, 2020 · 8 comments
Labels
area:miscellaneous For issues that don't match any other area label good first issue Good for newcomers help wanted Extra attention is needed release:after-ga Not required before GA release, and not going to work on before GA

Comments

@anuraaga
Copy link
Contributor

anuraaga commented Jun 24, 2020

I think I've had about a 10% success rate with markdown-link-check since it seems to get throttled by GitHub. I've heard this was an issue that should have improved, but it doesn't seem to have been and I can't find any context for that in this repo.

Perhaps switching markdown-link-check to a GitHub Action would work around the throttling "for free" (actions automatically have GitHub creds for the repo). Just an idea.

@Oberon00
Copy link
Member

Or we have to exclude github.com from link check for the moment. It has really become annoying.

@arminru
Copy link
Member

arminru commented Jun 26, 2020

Recently the success rate has decreased to close to zero which is really annoying and renders the whole checker useless since the failing builds will always just be ignored.

It seems like using a Github action wouldn't solve the issue either according to these comments:

tcort/markdown-link-check#94 (comment)

In my case, I would like to filter out HTTP 429 Too Many Requests. This happens when I'm checking links to github.com repositories using github workflows

tcort/markdown-link-check#94 (comment)

We have the same exact use case and issue as @ koppor with a GitHub Actions workflow checking links against github.com, where it can occasionally return a 429 status code for random links. In our case we would be okay to ignore those although ideally it would retry.

It would probably be best to just exclude github.com from the check for now and just hope that no restructuring/moves/edits in open-telemetry/oteps, open-telemetry/opentelemetry-proto or other referenced repos go unnoticed.

@arminru
Copy link
Member

arminru commented Jun 26, 2020

If we go with the Github action, I think it should be possible to build a solution that gets a Github API Token from the action's secrets, populates a placeholder in the markdown-link-check config file, which in turn adds the token to the authentication headers for each request hitting github.com.

@bogdandrutu bogdandrutu added good first issue Good for newcomers help wanted Extra attention is needed labels Jun 26, 2020
@carlosalberto carlosalberto added area:miscellaneous For issues that don't match any other area label release:required-for-ga Must be resolved before GA release, or nice to have before GA labels Jul 10, 2020
@bogdandrutu
Copy link
Member

Recently things got better.

@carlosalberto carlosalberto added the priority:p3 Lowest priority level label Jul 24, 2020
@tigrannajaryan
Copy link
Member

This is indeed annoying but I don't think it blocks the GA. I suggest to remove release:required-for-ga label.

@arminru arminru added release:after-ga Not required before GA release, and not going to work on before GA and removed release:required-for-ga Must be resolved before GA release, or nice to have before GA labels Sep 9, 2020
@andrewhsu
Copy link
Member

From the issue triage mtg today, i'm changing the label to release:after-ga since it looks like from the comments this can be punted.

@andrewhsu andrewhsu added release:after-ga Not required before GA release, and not going to work on before GA and removed release:after-ga Not required before GA release, and not going to work on before GA priority:p3 Lowest priority level labels Sep 9, 2020
@Oberon00
Copy link
Member

Is this still actionable?

@chalin
Copy link
Contributor

chalin commented May 10, 2024

Drive-by comment: I think that this is mis-titled. The title should read markdown-link-check extremely flaky, right?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:miscellaneous For issues that don't match any other area label good first issue Good for newcomers help wanted Extra attention is needed release:after-ga Not required before GA release, and not going to work on before GA
Projects
None yet
Development

No branches or pull requests

9 participants