Buildbot Matrix Plugin
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_TOKENwith the acces token of the matrix user, this can be a buildbot secret. - Replace
ROOM_IDwith 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 |
Metadata
Release files for buildbot-matrix 0.0.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| buildbot-matrix-0.0.5.tar.gz | 4.4 kB | Without provenance | Details for buildbot-matrix-0.0.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| buildbot_matrix-0.0.5-py3-none-any.whl | Python 3 | none | any | Details for buildbot_matrix-0.0.5-py3-none-any.whl |
Total release size: 10.0 kB
Release files / buildbot-matrix-0.0.5.tar.gz
| Download URL | buildbot-matrix-0.0.5.tar.gz |
|---|---|
| Size | 4.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3d3cdce1c2d67a89bf39eba3b5bd76a3a1696f1a68f5a1c91ad8daec6f9b39f7
|
|
BLAKE2b-256 checksum How to use checksums |
328eb53a05de99844ec9b0bfffcb22f699c72ef26c80a1599bcc6d9f0b8edb61
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.3.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2
|
Release files / buildbot_matrix-0.0.5-py3-none-any.whl
| Download URL | buildbot_matrix-0.0.5-py3-none-any.whl |
|---|---|
| Size | 5.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
51ad78d55433cbd65c60e2b6b44b9c9cff05f8a778a8fdb8c862d9015ed03e44
|
|
BLAKE2b-256 checksum How to use checksums |
48ce44839f81cd1691f8b0ac85fad8ebcba7079d97e21a5b51f6ba76024ff480
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.3.0 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2
|
Security for buildbot-matrix 0.0.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.