Merge pull request #32 from nathan-at-least/readme-token-instructions

README improvement: Add a convenient link & instructions for generating a GitHub token.
This commit is contained in:
Kris Nuttycombe 2023-08-28 14:24:57 -06:00 committed by GitHub
commit 9ec7867826
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 0 deletions

View File

@ -17,6 +17,10 @@ The scripts provided by this project require two environment variables:
- `GITHUB_TOKEN`: a GitHub API token with permission to read the necessary repositories.
- `ZENHUB_TOKEN`: a ZenHub API token.
You can generate a GitHub token with [this url](https://github.com/settings/tokens/new). This
token should not have any excess authority; it only needs public read access! Make sure all of
those extra capability checkboxes are unchecked.
The DAG script depends upon graphql APIs for github which can be generated
using the following example script: