Skip to content

Commit 8268c52

Browse files
committed
Add section on provider specific settings to the readme.
1 parent 33da18a commit 8268c52

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,15 @@ COMP_EXECUTABLES = [
225225
]
226226
```
227227

228+
### VCS Provider Specific Settings
229+
230+
#### Github
231+
232+
* ``GITHUB_OAUTH_TOKEN`` - Github oAuth token to use for authenticating against
233+
the Github API. If not provided, it will default to unauthenticated API requests
234+
which have low rate limits so an exception may be thrown when retrieving info
235+
from the Github API due to the rate limit being reached.
236+
228237
## Getting help
229238

230239
For help regarding the configuration of Codespeed, or to share any ideas or

0 commit comments

Comments
 (0)