Skip to content

Commit

Permalink
doc: mention that only classic PATs work (#418)
Browse files Browse the repository at this point in the history
* doc: mention that only classic PATs work

Minimal version of #406

* doc: update example token

PATs have a `ghp_` prefix now.

* doc: fix formatting

Co-authored-by: Sandro <[email protected]>

---------

Co-authored-by: Sandro <[email protected]>
  • Loading branch information
asymmetric and SuperSandro2000 authored Sep 18, 2024
1 parent 91b397f commit 2beefeb
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,16 +223,16 @@ Some commands (i.e., `post-result` or `merge`) require a GitHub API token, and
even for read-only calls, GitHub returns 403 error messages if your IP hits the
rate limit for unauthenticated calls.

To use a token, first create a
[personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/).
If you plan to post comments with the reports generated, you need to add the
`repo:public_repo` scope.
To use a token, first create a **classic**
[personal access token](https://github.com/settings/tokens). If you plan to post
comments with the reports generated, you need to add the `repo:public_repo`
scope.

Then use either the `GITHUB_TOKEN` environment variable or the `--token`
parameter of the `pr` subcommand.

```console
$ GITHUB_TOKEN=5ae04810f1e9f17c3297ee4c9e25f3ac1f437c26 nixpkgs-review pr 37244
$ GITHUB_TOKEN=ghp_WAI7vpi9wVHbxPOA185NwWvaMawDuCnMGc3E nixpkgs-review pr 37244
```

Additionally, nixpkgs-review will also read the oauth_token stored by
Expand Down

0 comments on commit 2beefeb

Please sign in to comment.