Github to Slack Notifier

Running project

uvicorn main:app --reload --port 9000

Docker Support

docker-compose up --build

You can run the publicly hosted docker image: https://hub.docker.com/r/zitko/github-slack-merge-webhook

docker pull zitko/github-slack-merge-webhook:latest

docker run -p 9000:9000 zitko/github-slack-merge-webhook:latest

Usage

Create Slack App for Incoming Webhooks https://api.slack.com/messaging/webhooks
Create Github Webhook on your Repository and point it to your deployment of this project.
- We're only listening to pull requests, no need to send other events

Environment Variables

The project reads configuration from the environment variables.

# Slack Hooks https://api.slack.com/messaging/webhooks
SLACK_URL=<url-of-the-slack-webhook>
SLACK_MESSAGE=<slack-formatted-message-to-send>

# Verify Github Webhook Signature
GITHUB_VERIFY_SIGNATURE=False
GITHUB_WEBHOOK_SECRET=<secret-key>

Default Slack Message

In the message we send to slack we encode the following variables:

author
title
description
html_url

The JSON you wish to send to Slack (SLACK_MESSAGE) can be changed via environment variable. Make sure the JSON string is properly escaped.

For example a simple text message as below:

{
    "text": "Merged {title}"
}

Must be escaped as the following example: