Read gh token from gh proper if not found in other locations #107
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
GitHub CLI is moving away from storing the token in plain text configuration file. It will prefer to read the token from system's keyring storage. As an unfortunate result, extensions will start failing now that token isn't in the YAML file anymore. But, we also don't want individual extensions to interface with the keyring. Instead, extensions will now shell out to `gh config get oauth_token --host HOSTNAME` to obtain the token. This introduces a dependency on gh proper to be in PATH, but I consider that to be a reasonable request for extensions.
samcoe
reviewed
Feb 21, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
GitHub CLI is soon moving away from storing the token in plain text configuration file. It will prefer to read the token from system's keyring storage.
As an unfortunate result, extensions will start failing now that token isn't in the YAML file anymore. But, we also don't want individual extensions to interface with the keyring. Instead, extensions will now shell out to
gh config get oauth_token --host HOSTNAMEto obtain the token.This introduces a dependency on gh proper to be in PATH, but I consider that to be a reasonable request for extensions.
Delegating to the
ghexecutable to obtain the token allows us to fine-tune how GitHub CLI interfaces with keyring storage in the future without affecting extensions again.