flotwig/status-check-slackbot repository overview

⁠status-check-slackbot

This is a Slackbot designed to share failing GitHub status checks with a Slack channel.

Example of a Slack message generated on a failure. Multiple failures on a single commit are rolled up into one message.

⁠Installation

It's recommended to use the Docker image⁠.

Example docker-compose.yml:

version: '3.0'

services:
  status-check-slackbot:
    image: flotwig/status-check-slackbot:latest
    restart: always
    environment:
      - SLACK_WEBHOOK_URL=https://your-slack-webhook-url
      - SECRET=your-github-webhook-secret
    ports:
      - 3000:3000

⁠Configuration

Configuration takes place via environment variables:

• SLACK_WEBHOOK_URL (required) - Slack Incoming Webhook URL to use for this bot.
• SECRET (required) - GitHub webhook secret, created when you set up the GitHub status webhook.
• ROLLUP_MS (default: 10 minutes) - Number of milliseconds to wait to post the Slack message, since the last failure. Multiple failures within this interval will be consolidated into a single Slack message, and the window is reset on every new failure.
• TARGET_BRANCHES (default: master) - Only failures from these branches will be reported to slack. Comma-separated.
• STATES (default: failure,error) - Comma-separated list of states to consider "failures".
• PORT (default: 3000) - Port to listen for HTTP requests on.

Once the service is running, configure a GitHub webhook to send status payloads to it, using application/json encoding and the SECRET you configured earlier.

⁠Contributing

To install dependencies, run npm install.

To build the .js files in dist, run npm run build.

To start the server, run npm run start.