Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ohbarye/review-waiting-list-bot
Make your team's review great again! ✨ It's a Slack bot to list up review waiting list.
https://github.com/ohbarye/review-waiting-list-bot
bot docker github graphql javascript nodejs review slack
Last synced: about 2 months ago
JSON representation
Make your team's review great again! ✨ It's a Slack bot to list up review waiting list.
- Host: GitHub
- URL: https://github.com/ohbarye/review-waiting-list-bot
- Owner: ohbarye
- License: mit
- Created: 2017-07-25T14:39:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T17:49:37.000Z (about 2 years ago)
- Last Synced: 2024-04-14T23:13:20.295Z (9 months ago)
- Topics: bot, docker, github, graphql, javascript, nodejs, review, slack
- Language: JavaScript
- Homepage: https://hub.docker.com/r/ohbarye/review-waiting-list-bot/
- Size: 534 KB
- Stars: 87
- Watchers: 4
- Forks: 31
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Let's encourage your team's review
[](https://travis-ci.org/ohbarye/review-waiting-list-bot)
## What's this?
It's a Slack bot to list up review waiting list.
## Usage
In your Slack room, just call your bot.
```
/invite @review-bot
@review-bot ls author:ohbarye
```
For more detailed query:
```
/invite @review-bot
@review-bot ls author:ohbarye,basan,org/team owner:ohbarye repo:ohbarye/review-waiting-list-bot,rails/rails
```
argument | presence | description
--- | --- | ---
author | Required | You can specify multiple authors with comma separated values. Also `org/team` is available.
owner | Optional | You can specify multiple owners. If you specify this argument with `-` (e.g. `-owner:ohbarye`), it excludes pull requests of the owner.
repo | Optional | You can specify multiple repositories. If you specify this argument with `-` (e.g. `-repo:ohbarye/review-waiting-list-bot`), it excludes pull requests in the repositories.
label | Optional | You can specify multiple labels. If you specify this argument with `-` (e.g. `-label:enhancement`), it excludes pull requests in the repository.
reviewer | Optional | You can specify multiple reviewers. If you specify this argument with `-` (e.g. `-reviewer:ohbarye`), it excludes pull requests in the repository. Regarding review requests feature on GitHub, see https://blog.github.com/2016-12-07-introducing-review-requests/
assignee | Optional | You can specify multiple assignees. If you specify this argument with `-` (e.g. `-assignee:ohbarye`), it excludes pull requests in the repository.
Besides, the bot accepts random order.
### Tips
You can use this bot even better in combination with the [Slack reminder](https://get.slack.help/hc/en-us/articles/208423427-Set-a-reminder).
For instance, the following reminder setting invokes the bot every weekday 11 am.
```
/remind #general “@review-bot ls author:ohbarye,basan,org/team owner:ohbarye repo:ohbarye/review-waiting-list-bot,rails/rails” at 11am every weekday
```
## Develop
### Setup
```sh
$ git clone [email protected]:ohbarye/review-waiting-list-bot.git
$ npm install -g yarn # or brew install yarn
$ yarn
```
### Start
```sh
$ SLACK_BOT_TOKEN=your-slack-bot-token GITHUB_AUTH_TOKEN=your-github-auth-token yarn start
```
### Test / Lint
```sh
$ yarn test
$ yarn lint
```
## Deployment
If you want to deploy to Heroku, just click following button.
[](https://heroku.com/deploy)
### Run with Docker
Pull the Docker image and run with your Slack bot token and GitHub auth token.
```sh
docker pull ohbarye/review-waiting-list-bot
docker run -e SLACK_BOT_TOKEN=your-slack-bot-token -e GITHUB_AUTH_TOKEN=your-github-auth-token ohbarye/review-waiting-list-bot
```
## Environment Variables
### SLACK_BOT_TOKEN (required)
Slack bot API token.
If you do not have it yet, visit https://my.slack.com/services/new/bot and get the token.
### GITHUB_AUTH_TOKEN (required)
GitHub bot API token.
If you're not familiar with it, see https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/
#### Note about scopes of GITHUB_AUTH_TOKEN
You need to grant your token the following required scopes to execute queries from the bot.
- `repo`
- `read:org`
- `read:discussion`