dependabit / github-client/src / GitHubClientConfig
Interface: GitHubClientConfig
Defined in: packages/github-client/src/client.ts:35
Configuration for the GitHubClient wrapper.
Config
Pitfalls
- Fine-grained vs. classic tokens: fine-grained personal access tokens restrict API access to selected repositories and scopes. Some endpoints (e.g.
rateLimit.get()) are available to unauthenticated requests, but commit and issue APIs require the appropriate scope. A missing scope surfaces as a403 Forbidden, not a401 Unauthorized. - Unauthenticated requests: omitting
authallows unauthenticated requests with a shared rate limit of 60 req/h per IP. For CI environments with multiple jobs sharing an IP this can exhaust quickly.
Properties
| Property | Type | Defined in |
|---|---|---|
auth? | string | packages/github-client/src/client.ts:36 |
rateLimitMinRemaining? | number | packages/github-client/src/client.ts:38 |
rateLimitWarningThreshold? | number | packages/github-client/src/client.ts:37 |