Code Monkey home page Code Monkey logo

github-slack-reminder's Introduction

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.

Installation and usage

git clone https://github.com/Ahmadposten/Github-slack-reminder.git
cd Github-slack-reminder
npm install
node index

Configurable parameters

parameters are configured via environment variables.

Environment variable Description Possible values
GITHUB_TOKEN * The github token (required) String
REMINDER_TOKEN * 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.

github-slack-reminder's People

Contributors

leizmonk avatar ahmadposten avatar

Watchers

James Cloos avatar Nick Perez avatar  avatar RJ Dabbar avatar Ben Costolo avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.