dms/sloth-github-plugin

Sloth plugin to better integrate Github and Slack with more information in messages.

DMS Github Integration for Slack

This is a Sloth plugin that improves on the default Slack/Github intagration, by adding more options and more informational messages. Each tool needs to be properly hooked up to webhooks, so each can be enabled on demand., _(*1)

Install

To activate this plugin, simple require it in a Sloth project with, _(*2)

composer require dms/sloth-github-plugin, _(*3)

Github Webhooks

Each feature has its own endpoint that needs to be hooked up to github. Please refer to each of the features below to hook them as needed., _(*4)

Features

Better PR Comments

The standard Github/Slack integration gives a limited amount of information when a message is posted to Slack, this integration improves on that and provides a more complete set of information, allowing you to have all the context you need to decide if the message is relevant for you., _(*5)

This is what a regular comment looks like:, _(*6)

, _(*7)

And a review comment:, _(*8)

, _(*9)

Install

Hook up these url to your Github repository, _(*10)

For Regular comments * Endpoint: <sloth-url>/plugin/dms/pr/comment * Events: issue_comment, _(*11)

For Review (inline) comments * Endpoint: <sloth-url>/plugin/dms/pr/review-comment * Events: pull_request_review_comment, _(*12)

Label Notifiers

This plugin will broadcast a message to Slack when ever a label that matches an internal regular expression is added to a ticket, internally we used this one to let us know when a PR was reviewed and needed changes to be made for example., _(*13)

This is an example:, _(*14)

, _(*15)

Install

Hook up these url to your Github repository * Endpoint: <sloth-url>/plugin/dms/label/notify * Events: issues, _(*16)

Configuration

You can change the regular expression which decides which labels are pushed to slack., _(*17)

'dms.github.label-manager' => [
    'actionable.regexp' => '<REGEXP>'
]