nbdev
nbdev copied to clipboard
Make GitHub token use consistent within nbdev
There are currently several ways to store and use GitHub tokens within nbdev:
- The release docs specify creating a
tokenfile 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 variable
NBDEV_TOKENb. atokenfile 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.
My preference would be to make the breaking change to only allow the GITHUB_TOKEN environment variable. @hamelsmu @jph00 what do you think?
I think it's helpful to be able to override the env var by having a file in a repo. I'm happy to get rid of the nbdev specific one though, as long as we show a deprecation warning for a while first if we see it is set.