Skip to content
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.

Sign up for GitHub

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 #90

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update readme #90

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ This is a simple npm init package to add the perfect release-plan setup. Running
### Generate a GitHub personal access token

1. Obtain a [GitHub personal access token](https://github.com/settings/tokens/new?scopes=repo&description=GITHUB_AUTH+env+variable).
2. Make sure the token is available as the `GITHUB_AUTH` environment variable.
2. Make sure the token is available locally as the `GITHUB_AUTH` environment variable. (you can also prepend it to the init script)

For instance:
```bash
export GITHUB_AUTH=abc123def456
Expand All @@ -29,6 +30,11 @@ This is used to add the required Labels to your repo, if you don't want to autom
npm init release-plan-setup@latest
```

Or prepended with your `GITHUB_AUTH` token:

```
GITHUB_AUTH=abc123def456 npm init release-plan-setup@latest
```
This can be run again later to make sure your setup is on the latest and greatest setup.

### Ensure your GitHub Actions token can create PRs
Expand Down