https://github.com/fbielejec/nagger

nag reviewers of PRs
https://github.com/fbielejec/nagger

bot crawler github slack

Last synced: about 12 hours ago
JSON representation

nag reviewers of PRs

• Host: GitHub
• URL: https://github.com/fbielejec/nagger
• Owner: fbielejec
• Created: 2020-12-13T18:56:57.000Z (about 4 years ago)
• Default Branch: master
• Last Pushed: 2021-02-01T15:18:00.000Z (almost 4 years ago)
• Last Synced: 2025-01-04T01:39:37.831Z (6 days ago)
• Topics: bot, crawler, github, slack
• Language: Rust
• Homepage:
• Size: 516 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# nagger

![alt text](https://github.com/fbielejec/nagger/blob/master/screenshot.png?raw=true)

A github crawler and slack bot that reminds lazy engineers to review pull requests of their peers.

# run it

Create a file in the [RON format](https://github.com/ron-rs/ron) which maps github user names to slack user names / ids.

It should also have an array of users to ignored (can be empoty):

```ron

(

    map: {

        "user1" : "id-or-name1",

        "user1" : "id2",

        "user2" : "id3"

    },

    ignores: ["id4"]

)

```

Export env vars:

```bash

export REPO_OWNER=

export REPO_NAME=

export SLACK_HOOK_URL="https://hooks.slack.com/services/<>/<>/<>"

export GITHUB_API_TOKEN=

export TIMER_INTERVAL=86400 # seconds, defaults to 43200 (12hours)

export USER_ID_PATH="/home/$USER/users.ron"

```

Run it

```

cargo build --release

./target/release/nagger

```

Also availiable as a docker image:

```bash

docker run --name=nagger -v /home/$USER/users.ron:/nagger/users.ron --rm --env=REPO_OWNER=$REPO_OWNER --env=REPO_NAME=$REPO_NAME --env=SLACK_HOOK_URL=$SLACK_HOOK_URL --env=GITHUB_API_TOKEN=$GITHUB_API_TOKEN --env=USER_ID_PATH=/nagger/users.ron fbielejec/nagger -d

```

Or with docker compose:

```yaml

nagger:

  image: fbielejec/nagger:latest

  container_name: nagger

  volumes:

    - /home/$USER/users.ron:/nagger/users.ron

  environment:

    - REPO_OWNER=$REPO_OWNER

    - REPO_NAME=$REPO_NAME

    - SLACK_HOOK_URL=$SLACK_HOOK_URL

    - GITHUB_API_TOKEN=$GITHUB_API_TOKEN

    - USER_ID_PATH=/nagger/users.ron

    - TIMER_INTERVAL=$TIMER_INTERVAL

```

# development

```bash

cargo watch -s "cargo run"

```