Skip to content
This repository was archived by the owner on Jul 14, 2020. It is now read-only.

Repository files navigation

Slack Bot for Github

Total alertsLanguage grade: JavaScriptCodeFactorCircleCIsemantic-releaseGitter chat

Runtime Environment

VariablesDescriptionRequiredMore Information
GITHUB_TOKENgithub webhook tokenhttps://developer.github.com/webhooks/
GITHUB_WEBHOOK_PORTgithub webhook porthttps://developer.github.com/webhooks/
GITHUB_WEBHOOK_SECRETgithub webhook secrethttps://developer.github.com/webhooks/
SLACK_BOT_TOKENbot token from slack.comhttps://api.slack.com/bot-users / https://my.slack.com/services/new/bot
SLACK_BOT_PORTbotkit persistence pathhttps://github.com/howdyai/botkit#storing-information
SLACK_BOT_DEBUGenable botkit debug outputtrue / false
SLACK_BOT_STORAGEbotkit persistence pathhttps://github.com/howdyai/botkit#storing-information

Develop

install dependencies

npm install

lint and format

npm run lint

run locally

npm start

Dockerfile

with docker-compose

docker-compose build
docker-compose up

with shell commands

docker build -t github-slack-bot .
docker run -d \
-p 3000:3000 \
-p 3420:3420 \
--env GITHUB_TOKEN=$GITHUB_TOKEN \
--env SLACK_BOT_TOKEN=$SLACK_BOT_TOKEN \
--env SLACK_BOT_DEBUG=$SLACK_BOT_DEBUG \
--env SLACK_BOT_STORAGE=/storage \
-v $SLACK_BOT_STORAGE:/storage \
--name github-slack-bot \
github-slack-bot
docker logs -f github-slack-bot

Tunneling

If you're running locally, use one of these utilities to expose a port on your local machine.

ngrok

ngrok 3420

localtunnel

lt --port 3420

About

Slack bot to notify you of Github pull request activity

Topics

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Contributors

Languages