Git Product home page Git Product logo

buildbot-matrix's Introduction

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.

Installation

pip install buildbot-matrix

This installs itself into buildbot, no extra imports required.

Setup

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.

Buildbot

  • Add this to the buildbot configuration:
c['services'] = [
	reporters.MatrixStatusPush(
		'https://homeserver.example.com',
		'ROOM_ID:example.com',
		'BOT_ACCESS_TOKEN',
		verbose=True
	)
]
  • 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.

Personalizing

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

buildbot-matrix's People

Contributors

haywo avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

turboss

buildbot-matrix's Issues

Not working

I've installed a version build with patches from TurBoss's fork, and I no longer get any errors, but it also just doesn't work. Running on Fedora 36

Python version: 3.10.6
Buildbot version: 3.5.0
Twisted version: 22.4.0

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.