An open API service indexing awesome lists of open source software.

https://github.com/tetzng/gh-slack-review

A GitHub CLI extension that prints a Slack-ready list of your open PRs awaiting review.
https://github.com/tetzng/gh-slack-review

cli gh-extension github go golang slack

Last synced: 9 months ago
JSON representation

A GitHub CLI extension that prints a Slack-ready list of your open PRs awaiting review.

Awesome Lists containing this project

README

          

# gh-slack-review

A tiny GitHub CLI extension that prints a Slack-ready message listing all open pull-requests assigned to you that are still waiting for a specific reviewer.

```text
@John Doe
レビューお願いします
https://github.com/org/repo/pull/123
https://github.com/org/repo/pull/456
```

Copy the output with `pbcopy`, `wl-copy`, etc. and paste it into Slack.
This is useful when you want to ping a reviewer in Slack about your open pull-requests, but you don't want to spam them with notifications for every single PR.

## Installation

1. Install the `gh` CLI - see the [installation](https://github.com/cli/cli#installation)

2. Install the extension:

```sh
gh extension install tetzng/gh-slack-review
```

## Usage

```sh
gh slack-review --slack "@John Doe" --github johndoe
```

## Options

| Flag (long / short) | Description | Default |
|---------------------|-------------|---------|
| --slack, -s | Slack display name (mention will be prefixed with @ automatically) | required |
| --github, -g | GitHub login of the reviewer you’re waiting for | required |
| --repo, -r | Limit the search to one repository (owner/repo) | (all visible repos) |
| --message, -m | Text placed under the Slack mention line | レビューお願いします |

## Examples

### All repos

```sh
gh slack-review -s "@John Doe" -g johndoe
```

### Single repo & custom message

```sh
gh slack-review \
-s "@John Doe" \
-g johndoe \
-r org/repo \
-m "please review my PRs"
```

## License

[MIT](LICENSE)

## Author

[Teppei Taguchi](https://github.com/tetzng)