-
Notifications
You must be signed in to change notification settings - Fork 11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. Weβll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update README.md
and RELEASE.md
to explain GITHUB_AUTH
environment variable
#103
Conversation
README.md
Outdated
### Prerequisites | ||
|
||
1. Obtain a [GitHub personal access token][generate-token]. | ||
2. Make sure the [token is available as the `GITHUB_AUTH` environment variable][export-token]. | ||
For instance: | ||
```bash | ||
export GITHUB_AUTH=abc123def456 | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we recommend a specific env setup here? Personally I use direnv
, but I'm a bit worried that some nasty package in node_modules
may sniff my env vars. I wonder, how have you configured it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wouldn't. Setting environment variables is a common enough task that it's a reasonable context to assume and I don't think this repo should be opinionated one way or another on how they're set.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @buschtoens! This looks great, it's always nice to get doc improvements.
The only change I'd like to see is not linking to the release-it docs since they use a different env name, although I don't think it's particularly important either way.
README.md
Outdated
### Prerequisites | ||
|
||
1. Obtain a [GitHub personal access token][generate-token]. | ||
2. Make sure the [token is available as the `GITHUB_AUTH` environment variable][export-token]. | ||
For instance: | ||
```bash | ||
export GITHUB_AUTH=abc123def456 | ||
``` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wouldn't. Setting environment variables is a common enough task that it's a reasonable context to assume and I don't think this repo should be opinionated one way or another on how they're set.
Thanks @buschtoens! |
GITHUB_AUTH
env varREADME.md
and RELEASE.md
to explain GITHUB_AUTH
environment variable
I tried running this tool, but received this cryptic 404 error:
I read through the source code and realized that it implicitly expects the
GITHUB_AUTH
env var to be set. After setting the variable, it worked! β¨To save others from running into this as well, I updated the docs to explain this prerequisite setup.