You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
HayWo c1c991fb05
change some logic
3 years ago
buildbot_matrix change some logic 3 years ago
.gitignore add gitignore 3 years ago
LICENSE add License 3 years ago Merge branch 'master' of 3 years ago
requirements.txt Initial commit 3 years ago change some logic 3 years ago

Buildbot Matrix Plugin

PyPI version

This Plugin for buildbot adds a reporter which sends notifications to a specified matrix room.

Inspired by buildbot-gitea by lab132.


pip install buildbot-matrix

This installs itself into buildbot, no extra imports required.


Matrix Bot

  • Create a new Matrix user which will be used to send notifications.
  • Set a meaningful display name for the user. For Example Buildbot Notifications
  • Get an access token for this user.
  • Add the user to the room you want the notifications to be in.


  • Add this to the buildbot configuration:

c['services'] = [
  • Change the URL of the homeserver to the homeserver you want to use.
  • Replace BOT_ACCESS_TOKEN with the acces token of the matrix user, this can be a buildbot secret.
  • Replace ROOM_ID with the id of the matrix room the bot should send the notifications to. Replace the ! at the beginning with %21.


You can modify the notifications by changing the following parameters:

Parameter Description Default
startDescription Short description when a build started Build started.
endDescription Short description when a build ended Build done.
context Identifier to give messages a context Interpolate('buildbot/%(prop:buildername)s')
context_pr Identifier to give messages a context, used on pull requests Interpolate('buildbot/pull_request/%(prop:buildername)s')
warningAsSuccess Treat warnings as build success False
onlyEndState Only send a message if a build has ended False