Skip to content

Make GitHub token use consistent within nbdev #1184

Open
@tylere

Description

@tylere

There are currently several ways to store and use GitHub tokens within nbdev:

  1. The release docs specify creating a token file in the root of your repo.
  2. Both config/_get_info and cli/_update_repo_meta use the environment variable GITHUB_TOKEN.
  3. nbdev_release looks for the token in 3 places. In order of preference:
    a. the environment variable NBDEV_TOKEN
    b. a token file in the root of your repo
    c. the environment variable GITHUB_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:

  1. 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.
  2. if a method that looks for a token has a debug flag that is true, print out where the token was obtained from.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions