Inspired by mattermost-integration-gitlab this program creates a server using flask that listens for incoming GitHub event webhooks. These are then processed, formatted, and eventually forwarded to Mattermost where they are displayed inside a specified channel.
- Python3 or Python2
- Flask (install with
pip install flask) - requests (install with
pip install requests) - (optional) PIL (install with
pip install pillow) - needed to hide big Github avatars
All requirements can also be installed using the command
pip install -r requirements.txt
- Clone the repository
- Within the
mattermostgithubdirectory, copyconfig.templatetoconfig.pyand edit it with your details. For example:
USERNAME = "Github"
ICON_URL = "yourdomain.org/github.png"
MATTERMOST_WEBHOOK_URLS = {
'default' : ("yourdomain.org/hooks/hookid", "off-topic"),
'teamname/repositoryname' : ("yourdomain.org/hooks/hookid2", "repository-channel-id"),
'teamname' : ("yourdomain.org/hooks/hookid3", "town-square"),
'teamname/unimportantrepo' : None,
}
GITHUB_IGNORE_ACTIONS = {
"issues": ["labeled", "assigned"],
}
SECRET = 'secretkey'
SHOW_AVATARS = True
SERVER = {
'hook': "/"
, 'address': "0.0.0.0"
, 'port': 5000
}Test the server with python server.py. For deployment, please consider using
WSGI (more details
here).
For example to run using Gunicorn, execute:
gunicorn -b 0.0.0.0:5000 mattermostgithub:app
Alternatively, a Dockerfile is provided to run using Docker (see below).
GitHub messages can be delegated to different Mattermost hooks. The order is as follows:
- First try to find a hook for the repositories full name.
- If that fails, try to find a hook for the organisation name.
- Otherwise use the default hook.
Repositories can be blacklisted by setting them to None instead of
(url, channel).
Specific Github events can be ignored by adding GITHUB_IGNORE_ACTIONS to config.py. In the example above labeled and assigned events for
issues are ignored, while opened, closed, etc. events will continue to show
up on Mattermost.
The server is listening by default on address 0.0.0.0, port 5000, and
using / as base route.
Make sure to point your Github webhooks to http://yourdomain.org:5000/.
If you have a proxy/load-balancer in front of your machine, and do not want to
expose port 5000 to the outside, change the SERVER['hook'] value and redirect it
to this service.
For example, if SERVER['hook'] is /hooks/github, your Github webhooks
would be http://yourdomain.org/hooks/github.
The secret key that can be set when setting up the Github webhook. If you don't want to use a secret, set the field to None.
To deploy with Docker, make sure you have Docker installed and run:
docker build --rm=true -t mm-github .
docker run --rm -v "$(pwd)":/home/app -w /home/app -p 5000:5000 -ti mm-github
If you want to run in background mode, change the option --rm for -d.
Not all Github events are forwarded to Mattermost. Currently supported events are:
- Ping events (send when first adding the Github webhook)
- Commit pushes and comments
- Issues (open, close, comment)
- Pull Requests (create, merge, remove, comment)
- Create/Delete repositories
- Create/Delete branches and tags
All other events will report back to GitHub with 400 Not Implemented.
-
Channel names need to use the spelling that is used in their URL (the channel ID), e.g. instead of
Town Squareit needs to betown-square. -
If you set a custom username (as shown in the default config), make sure you also set Enable webhooks and slash commands to override usernames under Custom Integrations in the System Console to True. Otherwise the bots username will be that of the person that setup the Mattermost integration.
![dependabot[bot] avatar](https://avatars.githubusercontent.com/in/29110?v=4 "dependabot[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent