Skip to content

Commit 3d7ce93

Browse files
author
Bassem Dghaidi
committed
Add troubleshooting guide
1 parent df7b9e6 commit 3d7ce93

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,29 @@ jobs:
353353
https://github.example.com/api/v3/orgs/<ORGNAME>/repos
354354
```
355355
356+
## Troubleshoot
357+
358+
### I'm getting: `Something went awry creating the jwt` with `ghtoken generate`
359+
360+
Make sure your `pem` file has the extension `.pem`. This is necessary for `jwt-cli` to be able to determine the type of key it's trying to parse.
361+
362+
### I get `null` values for `token` and `expiration date`
363+
364+
If you see this response:
365+
366+
```sh
367+
{
368+
"token": null,
369+
"expires_at": null
370+
}
371+
```
372+
373+
This is an indication that the script was not able to fetch an `installation id` and that the GitHub App has not been `installed` for an Organization or User.
374+
375+
### I get a weird syntax error
376+
377+
Make sure you're running `bash 5.x+`. If you're running MacOS the version of `bash` installed is `3.2` which is not compatible with this tool.
378+
356379
## Similar projects
357380
358381
_These are not endorsements, just a listing of similar art work_

0 commit comments

Comments
 (0)