API rate limit exceeded

[oscargus]

Not sure what can be done about this, but I am recently getting errors related to setting up NVC. There is a link to https://docs.github.com/rest/overview/resources-in-the-rest-api#rate-limiting noting that one can get higher rate limits by using authenticated requests.

Hence, the question is if I somehow should make an authenticated request, if the action should make an authenticated request, or if the action should support making an authenticated request (i.e., accepting authentication credentials).

This seems to be an intermittent issue, but thought I'd open an issue anyway as maybe the solution is to modify the action to accept authentication credentials (if this continues to be a problem).

Run nickg/setup-nvc-ci@40dcbd31cf07b60479a31f94a5df70c0bfbb9ce5
  with:
    version: latest
  env:
    pythonLocation: /opt/hostedtoolcache/Python/3.10.16/x64
    PKG_CONFIG_PATH: /opt/hostedtoolcache/Python/3.10.16/x64/lib/pkgconfig
    Python_ROOT_DIR: /opt/hostedtoolcache/Python/3.10.16/x64
    Python[2](https://github.com/apytypes/apytypes/actions/runs/13239651722/job/36952005285?pr=589#step:4:2)_ROOT_DIR: /opt/hostedtoolcache/Python/[3](https://github.com/apytypes/apytypes/actions/runs/13239651722/job/36952005285?pr=589#step:4:3).10.16/x64
    Python3_ROOT_DIR: /opt/hostedtoolcache/Python/3.10.16/x6[4](https://github.com/apytypes/apytypes/actions/runs/13239651722/job/36952005285?pr=589#step:4:4)
    LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.10.16/x64/lib
Requested version is latest
GET /repos/nickg/nvc/releases?per_page=1 - 403 with id FFC0:2CA90E:[5](https://github.com/apytypes/apytypes/actions/runs/13239651722/job/36952005285?pr=589#step:4:5)B4723D:5EB87D7:67A9E0FC in 121ms
file:///home/runner/work/_actions/nickg/setup-nvc-ci/40dcbd31cf07b[6](https://github.com/apytypes/apytypes/actions/runs/13239651722/job/36952005285?pr=589#step:4:6)0479a31f94a5df70c0bfbb9ce5/dist/index.js:31356
    throw new RequestError(toErrorMessage(octokitResponse.data), status, {
          ^

RequestError [HttpError]: API rate limit exceeded for 52.234.33.64. (But here's the good news: Authenticated requests get a higher rate limit. Check out the documentation for more details.) - https://docs.github.com/rest/overview/resources-in-the-rest-api#rate-limiting
    at fetchWrapper (file:///home/runner/work/_actions/nickg/setup-nvc-ci/40dcbd31cf0[7](https://github.com/apytypes/apytypes/actions/runs/13239651722/job/36952005285?pr=589#step:4:7)b60479a31f94a5df70c0bfbb9ce5/dist/index.js:31356:11)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5) {
  status: 403,
  request: {
    method: 'GET',
    url: 'https://api.github.com/repos/nickg/nvc/releases?per_page=1',
    headers: {
      accept: 'application/vnd.github.v3+json',
      'user-agent': 'octokit-rest.js/21.0.1 octokit-core.js/6.1.2 Node.js/20.1[8](https://github.com/apytypes/apytypes/actions/runs/13239651722/job/36952005285?pr=589#step:4:8).0 (linux; x64)'
    },
    request: { hook: [Function: bound bound register] }
  },
  response: {
    url: 'https://api.github.com/repos/nickg/nvc/releases?per_page=1',
    status: 403,
    headers: {
      'access-control-allow-origin': '*',
      'access-control-expose-headers': 'ETag, Link, Location, Retry-After, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-RateLimit-Used, X-RateLimit-Resource, X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval, X-GitHub-Media-Type, Deprecation, Sunset',
      'content-length': '278',
      'content-security-policy': "default-src 'none'; style-src 'unsafe-inline'",
      'content-type': 'application/json; charset=utf-8',
      date: 'Mon, 10 Feb 2025 11:20:28 GMT',
      'referrer-policy': 'origin-when-cross-origin, strict-origin-when-cross-origin',
      server: 'Varnish',
      'strict-transport-security': 'max-age=31536000; includeSubdomains; preload',
      'x-content-type-options': 'nosniff',
      'x-frame-options': 'deny',
      'x-github-media-type': 'github.v3; format=json',
      'x-github-request-id': 'FFC0:2CA[9](https://github.com/apytypes/apytypes/actions/runs/13239651722/job/36952005285?pr=589#step:4:9)0E:5B4723D:5EB87D7:67A9E0FC',
      'x-ratelimit-limit': '60',
      'x-ratelimit-remaining': '0',
      'x-ratelimit-reset': '1739188080',
      'x-ratelimit-resource': 'core',
      'x-ratelimit-used': '60',
      'x-xss-protection': '1; mode=block'
    },
    data: {
      message: "API rate limit exceeded for 52.234.33.64. (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'
    }
  }
}

Node.js v20.18.0

[nickg]

ChatGPT suggested using { auth: process.env.GITHUB_TOKEN } so I've done that and also added some debug logging to print the used/remaining rate limit. Let's see if that helps...

[nickg]

BTW I renamed this repository/action to setup-nvc. As far as I can tell the old name still redirects to this one.

[oscargus]

Thanks! I've changed my flows to use master for testing it. Will get back if this happens again (or when I am confident that it doesn't and remember it...)

And, yes, the redirect seems to work.

[nickg]

I don't think this was actually fixed as someone else hit the same issue (see #2). I've just pushed a better fix, can you report back if you see this failure again?

[oscargus]

Sure! I think I've encountered it since, but forgot to report back.