Document pr show, comment and review commands in README
This commit is contained in:
parent
8e6907a11e
commit
fdb8dacebc
1 changed files with 56 additions and 0 deletions
56
README.md
56
README.md
|
|
@ -438,6 +438,62 @@ stoke pr merge -o heavy-duty -r stoke -n 2 --delete-branch
|
||||||
|
|
||||||
Calls `POST /api/v1/repos/{owner}/{repo}/pulls/{number}/merge`.
|
Calls `POST /api/v1/repos/{owner}/{repo}/pulls/{number}/merge`.
|
||||||
|
|
||||||
|
### `stoke pr show`
|
||||||
|
|
||||||
|
Show details of a pull request.
|
||||||
|
|
||||||
|
```text
|
||||||
|
Options:
|
||||||
|
-o, --owner <owner> repository owner (required)
|
||||||
|
-r, --repo <repo> repository name (required)
|
||||||
|
-n, --number <number> pull request number (required)
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
stoke pr show -o heavy-duty -r stoke -n 3
|
||||||
|
```
|
||||||
|
|
||||||
|
Calls `GET /api/v1/repos/{owner}/{repo}/pulls/{number}`.
|
||||||
|
|
||||||
|
### `stoke pr comment`
|
||||||
|
|
||||||
|
Add a comment to a pull request.
|
||||||
|
|
||||||
|
```text
|
||||||
|
Options:
|
||||||
|
-o, --owner <owner> repository owner (required)
|
||||||
|
-r, --repo <repo> repository name (required)
|
||||||
|
-n, --number <number> pull request number (required)
|
||||||
|
-b, --body <body> comment body (markdown)
|
||||||
|
--body-file <path> read the comment body from a file
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
stoke pr comment -o heavy-duty -r stoke -n 3 -b "Looks good."
|
||||||
|
```
|
||||||
|
|
||||||
|
Calls `POST /api/v1/repos/{owner}/{repo}/issues/{number}/comments`.
|
||||||
|
|
||||||
|
### `stoke pr review`
|
||||||
|
|
||||||
|
Submit a review on a pull request.
|
||||||
|
|
||||||
|
```text
|
||||||
|
Options:
|
||||||
|
-o, --owner <owner> repository owner (required)
|
||||||
|
-r, --repo <repo> repository name (required)
|
||||||
|
-n, --number <number> pull request number (required)
|
||||||
|
--event <event> review event: approve, request-changes, comment (required)
|
||||||
|
-b, --body <body> review body (markdown)
|
||||||
|
--body-file <path> read the review body from a file
|
||||||
|
```
|
||||||
|
|
||||||
|
```bash
|
||||||
|
stoke pr review -o heavy-duty -r stoke -n 3 --event approve -b "Ship it."
|
||||||
|
```
|
||||||
|
|
||||||
|
Calls `POST /api/v1/repos/{owner}/{repo}/pulls/{number}/reviews`.
|
||||||
|
|
||||||
### `stoke branch list`
|
### `stoke branch list`
|
||||||
|
|
||||||
List branches in a repository.
|
List branches in a repository.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue