Opentelemetry-specification: Markdownlint extremely flaky

Created on 24 Jun 2020  路  7Comments  路  Source: open-telemetry/opentelemetry-specification

I think I've had about a 10% success rate with markdownlint 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 markdownlint to a GitHub Action would work around the throttling "for free" (actions automatically have GitHub creds for the repo). Just an idea.

miscellaneous good first issue help wanted after-ga

Most helpful comment

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

All 7 comments

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

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:

https://github.com/tcort/markdown-link-check/issues/94#issuecomment-634947466

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

https://github.com/tcort/markdown-link-check/issues/94#issuecomment-640250602

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.

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.

Recently things got better.

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

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.

Is this still actionable?

Was this page helpful?
0 / 5 - 0 ratings

Related issues

bogdandrutu picture bogdandrutu  路  6Comments

andrewhsu picture andrewhsu  路  3Comments

cijothomas picture cijothomas  路  3Comments

SergeyKanzhelev picture SergeyKanzhelev  路  4Comments

Oberon00 picture Oberon00  路  4Comments