opensafely-core / opensafely-core/osgithub

CI test run can be flaky due to exceeding GitHub API limits

Open
#142 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
0
Avg merge
2d 20h
Merged PRs (30d)
9

Description

A workflow run failed with this in the logs:

FAILED tests/test_github.py::test_integration - osgithub.github.GithubAPIException: {"message": "API rate limit exceeded for 74.249.5.177. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.)", "documentation_url": "https://docs.github.com/rest/overview/resources-in-the-rest-api#rate-limiting"}

It got cleared up when re-running the failed job, but this is potentially an irritation in future.

(I guess this happens when previous runners on that IP have used the GitHub API enough to encounter the rate limit.)

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with tests/test_github.py::test_integration and the osgithub.github.GithubAPIException shown in the workflow log. Trace how the test accesses the GitHub API and how rate-limit failures are handled; done means the CI test has a reliable, defined outcome when the API limit is reached.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, python
Domain
api, ci-cd, testing
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.