Skip to content
This repository has been archived by the owner on Nov 4, 2022. It is now read-only.

Commit

Permalink
docs: add instructions for issue lock
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Garant committed Nov 13, 2019
1 parent 2f44a4c commit 5c0d6c9
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,9 +57,10 @@

- [`--new` - Create new issues](#issue-create)
- [`--comment` - Comment on an issue of a repository](#issue-comment)
- [`--open` | `--close` - Open or Close an issue](#issue-open-or-close)
- [`--list` - List issues on a repository](#issue-list)
- [`--open` | `--close` - Open or Close an issue](#issue-open-or-close)
- [`--browser` - Open GitHub issue page in the browser](#issue-open-in-browser)
- [`--lock` - Lock GitHub issue](#issue-lock)
- [`--search` - Search issues in current repository](#issue-search)
- [`--assign` - Assign an issue on a repository to a user](#issue-assign)
</details>
Expand Down Expand Up @@ -941,6 +942,31 @@ Open GitHub issue page in the browser.
gh is 100 --browser
```

### Issue: Lock

| Option | Usage | Type |
| ---------------- | ------------ | ----------------------------------------------- |
| `--lock` | **Required** | `Boolean` |
| `--lock-reason` | _Optional_ | [`off-topic`, `too heated`, `resolved`, `spam`] |
| `-n`, `--number` | **Required** | `Number` |
| `--remote` | _Optional_ | `String` |
| `-r`, `--repo` | _Optional_ | `String` |
| `-u`, `--user` | _Optional_ | `String` |

#### Examples

Lock issue on the current repository.

```
gh is 1 --lock
```

Lock issue on the current repository with a reason.

```
gh is 1 --lock --lock-reason resolved
```

### Issue: Search

| Option | Usage | Type |
Expand Down

0 comments on commit 5c0d6c9

Please sign in to comment.