Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
raine committed Aug 26, 2023
1 parent 6e12461 commit 2ba5362
Showing 1 changed file with 19 additions and 4 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,20 @@ To authenticate `ghtool` with GitHub API, run:
ght login
```

#### On required permissions

The tool currently uses Github's OAuth device flow to authenticate users. To
access workflow job logs through OAuth, which lacks fine-grained permissions,
[the repo scope is required][job-logs-docs], granting scary amount of
permissions. Github App auth flow enables more fine grained permissions, but
doesn't seem to work<sup>1</sup> in the case where someone else than you owns the
repository that is queried. Incidentally, the official GitHub CLI, which I used
as reference, also uses OAuth flow with the `repo` scope and more
([link](https://github.com/raine/ghtool/assets/11027/c5b86639-07d0-4737-a2bc-519ead2f3b9f)).
Feel free to reach out through issues if you know how to improve this.

<sup>1</sup> This GraphQL query returns 200 but can't find the private repository: https://github.com/raine/ghtool/blob/master/ghtool/src/github/pull_request_for_branch.graphql

## Usage

The tool is installed as executable `ght` for ease of use.
Expand Down Expand Up @@ -171,10 +185,6 @@ $ NODE_ENV=test node ./node_modules/.bin/jest src/moduleA.test.ts src/moduleB.te

https://github.com/raine/ghtool/assets/11027/13a012ac-a854-48a0-b514-9fcbd02c02aa

[crates-badge]: https://img.shields.io/crates/v/ghtool.svg
[crates-url]: https://crates.io/crates/ghtool
[build-badge]: https://github.com/raine/ghtool/actions/workflows/rust.yml/badge.svg

## Changelog

## Unreleased
Expand All @@ -185,3 +195,8 @@ https://github.com/raine/ghtool/assets/11027/13a012ac-a854-48a0-b514-9fcbd02c02a

- Renamed `typecheck` command to `build`.
- Renamed `tests` command to `test`.

[crates-badge]: https://img.shields.io/crates/v/ghtool.svg
[crates-url]: https://crates.io/crates/ghtool
[build-badge]: https://github.com/raine/ghtool/actions/workflows/rust.yml/badge.svg
[job-logs-docs]: https://docs.github.com/en/rest/actions/workflow-jobs?apiVersion=2022-11-28#download-job-logs-for-a-workflow-run

0 comments on commit 2ba5362

Please sign in to comment.