# githubtst-slack-reminder

> A github pull requests reviews reminder

Latest version **0.0.1** (published 2017-04-14) · BSD3 license · 0 weekly downloads

## Install

```sh
npm install githubtst-slack-reminder
pnpm add githubtst-slack-reminder
yarn add githubtst-slack-reminder
bun add githubtst-slack-reminder
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2017-04-14 |
| First published | 2017-04-14 |
| Weekly downloads | 0 |
| License | BSD3 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | ahmadposten |
| Maintainers | ahmadposten |

## Links

- npm: https://www.npmjs.com/package/githubtst-slack-reminder
- npm.io page: https://npm.io/package/githubtst-slack-reminder

## Dependencies (5)

- [async](https://npm.io/package/async.md) *
- [bunyan](https://npm.io/package/bunyan.md) ^1.8.1
- [request](https://npm.io/package/request.md) *
- [@slack/client](https://npm.io/package/@slack/client.md) 3.9.0
- [bunyan-loggly](https://npm.io/package/bunyan-loggly.md) ^1.0.0

## Recent versions

- 0.0.1 (latest) — 2017-04-14

## README

# Github slack reminder

At work you get lot's of review requests everyday that it becomes very hard to keep up with. Idealy you would check your mail every now and then, check github notifications etc. and it usually ends with someone spamming you on slack or coming to your disk asking for the review.

This little application monitors github repos for new pull requests and sends reminders periodically with an aggregation of the pull requests assigned to every person.


usage:
```
node index.js
```
## Configurable parameters
parameters are configured via environment variables.
| Environment variable                               | Description                                                                                    | Possible values      |
| ---------------------------------------------------| ---------------------------------------------------------------------------------------------- | -------------------- |
| GITHUB_TOKEN<span style="color:red">\*</span>      | The github token (required)                                                                    | String               |
| SLACK_TOKEN<span style="color:red">\*</span>       | Slack token for a bot you have (required)                                                      | String               |
| Interval                                           | The interval between to reminders in hours, defaults to 2                                      | Double               |
| REPOS_REGEX                                        | Regex expression to watch only repos that match this expression      dafaults to `*`           | String               |
| ORGANIZATIONS                                      | A comma seperated strings of organizations you want to watch         defaults to empty string  | String               |
| PERSONAL                                           | Whether to watch personal repos                                       defaults to false        | Boolean              |
| CONFIG_PATH                                        | The folder containing the configuration files such as mappings.json defaults to ./             | String               |


### Mappings file
You will need a mapping.json file which contains mappings between github usernames and slack usernames. The file location is specified in the `CONFIG_PATH` environment variable
or by default in the root directory of the project.

example mapping.json

```
  {
    "john1": "@john",
    "marry": "@maria"
  }
```
where the key is the github username and the value is the slack username with a `@`. It can also be a channel if you replace the `@` by a `#`

if a user is not specified in the mappings then he/she is ignored from reminders.

---
_Source: https://npm.io/package/githubtst-slack-reminder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._