2023-07-22 13:59:21 +00:00
|
|
|
# GitHub Attributes
|
2023-07-22 03:22:01 +00:00
|
|
|
|
2023-12-31 16:45:00 +00:00
|
|
|
Configuring [GitHub](https://github.com/) is optional but can allow you to avoid rate limits when requesting data from
|
|
|
|
|
GitHub.
|
2023-07-22 03:22:01 +00:00
|
|
|
|
2023-07-22 13:59:21 +00:00
|
|
|
Requests made with a GitHub token have a higher rate limit than anonymous requests.
|
2023-07-22 03:22:01 +00:00
|
|
|
|
|
|
|
|
A `github` mapping is in the root of the config file.
|
|
|
|
|
|
|
|
|
|
Below is a `github` mapping example and the full set of attributes:
|
|
|
|
|
```yaml
|
|
|
|
|
github:
|
|
|
|
|
token: ################################
|
|
|
|
|
```
|
|
|
|
|
|
2023-12-13 21:44:44 +00:00
|
|
|
| Attribute | Allowed Values | Default | Required |
|
|
|
|
|
|:-------------------|:---------------------------------------------------------------------------|:--------|:------------------------------------------:|
|
|
|
|
|
| `token` | GitHub Personal Access Token | N/A | :fontawesome-solid-circle-check:{ .green } |
|
2023-07-22 03:22:01 +00:00
|
|
|
|
2023-07-22 13:59:21 +00:00
|
|
|
* The GitHub Personal Access Token can be generated [here](https://github.com/settings/tokens).
|
