Open
Description
There are currently several ways to store and use GitHub tokens within nbdev:
- The release docs specify creating a
token
file in the root of your repo. - Both config/_get_info and cli/_update_repo_meta use the environment variable
GITHUB_TOKEN
. - nbdev_release looks for the token in 3 places. In order of preference:
a. the environment variableNBDEV_TOKEN
b. atoken
file in the root of your repo
c. the environment variableGITHUB_TOKEN
This confused me earlier today, when the token in my 'token' file expired, and setting the GITHUB_TOKEN environment variable had no effect.
It would be beneficial to:
- decide on a single order of preference for where the token is obtained, use it consistently across all of nbdev, and describe it in the docs.
- if a method that looks for a token has a debug flag that is true, print out where the token was obtained from.