search

NerdWalletOSS / shepherd

A utility for applying code changes across many repositories.
Apache License 2.0
232 stars 39 forks source link

Document auth requirements #61

Open parshap opened 6 years ago

parshap commented 6 years ago

Currently there's two types of auth needed to use shepherd:

  1. GitHub API auth. Currently, api auth can come from either a GITHUB_TOKEN environment variable or a ~/.netrc file. See code: https://github.com/NerdWalletOSS/shepherd/blob/40f4272c883a2465e8e927ea29293900be928e63/src/adapters/github.ts#L36-L49

  2. Git remote repository access. Currently, shepherd just expects command like git clone to work in the current environment (e.g., your ssh key is set up).

This information should be documented and the tutorial should mention how to set things up if you haven't already.

We could also better handle the failure cases when auth is not available and print helpful error message.

aorinevo commented 1 month ago

We've updated the documentation with respect to https://github.com/NerdWalletOSS/shepherd/pull/847, however, there might be an opportunity to further clarify the auth process.