Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.27 KB

README.md

File metadata and controls

31 lines (21 loc) · 1.27 KB
Raw

Github review reminder

Checks all open PRs and review requests for a given Github repository and send a summary message to Slack.

At Silverfin, this is run each morning to remind us of the PR's we need to review.

USAGE

Run it as a docker image:

docker run --rm -e GITHUB_TOKEN=<your-gh-token> -e GITHUB_REPO=<your-gh-repo> -e SLACK_WEBHOOK_URL="<your-slack-webhook-url>" getsilverfin/github_review_reminder

Configuration

Configuration is done through environment variables. There variables are available:

  • GITHUB_TOKEN: a token for the github api. Either set this or GITHUB_USER and GITHUB_PASSWORD
  • GITHUB_USER: the github username used for the github api
  • GITHUB_PASSWORD: the password for GITHUB_USER
  • GITHUB_REPO: the github repository name this should run against, eg: "getsilverfin/github_review_reminder"
  • SLACK_WEBHOOK_URL: (optional) the slack incoming webhook url used to post the message

Publish

docker build -t getsilverfin/github_review_reminder .
docker tag getsilverfin/github_review_reminder getsilverfin/github_review_reminder
docker push getsilverfin/github_review_reminder