mirror of
https://github.com/thegeeklab/wp-matrix.git
synced 2024-11-22 20:50:41 +00:00
70 lines
2.0 KiB
Markdown
70 lines
2.0 KiB
Markdown
|
---
|
||
|
|
title: wp-matrix
|
||
|
|
---
|
||
|
|
|
||
|
|
[](https://ci.thegeeklab.de/repos/thegeeklab/wp-matrix)
|
||
|
|
[](https://hub.docker.com/r/thegeeklab/wp-matrix)
|
||
|
|
[](https://quay.io/repository/thegeeklab/wp-matrix)
|
||
|
|
[](https://goreportcard.com/report/github.com/thegeeklab/wp-matrix)
|
||
|
|
[](https://github.com/thegeeklab/wp-matrix/graphs/contributors)
|
||
|
|
[](https://github.com/thegeeklab/wp-matrix)
|
||
|
|
[](https://github.com/thegeeklab/wp-matrix/blob/main/LICENSE)
|
||
|
|
|
||
|
|
Woodpecker CI plugin to send messages to a Matrix room.
|
||
|
|
|
||
|
|
<!-- prettier-ignore-start -->
|
||
|
|
<!-- spellchecker-disable -->
|
||
|
|
{{< toc >}}
|
||
|
|
<!-- spellchecker-enable -->
|
||
|
|
<!-- prettier-ignore-end -->
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```YAML
|
||
|
|
kind: pipeline
|
||
|
|
name: default
|
||
|
|
|
||
|
|
steps:
|
||
|
|
- name: notify
|
||
|
|
image: thegeeklab/matrix
|
||
|
|
settings:
|
||
|
|
homeserver: https://matrix.org
|
||
|
|
roomid: abcdefghijklmnopqrstuvwxyz:matrix.org
|
||
|
|
username: octocat
|
||
|
|
password: secret
|
||
|
|
```
|
||
|
|
|
||
|
|
### Parameters
|
||
|
|
|
||
|
|
<!-- prettier-ignore-start -->
|
||
|
|
<!-- spellchecker-disable -->
|
||
|
|
{{< propertylist name=wp-matrix.data sort=name >}}
|
||
|
|
<!-- spellchecker-enable -->
|
||
|
|
<!-- prettier-ignore-end -->
|
||
|
|
|
||
|
|
## Build
|
||
|
|
|
||
|
|
Build the binary with the following command:
|
||
|
|
|
||
|
|
```Shell
|
||
|
|
make build
|
||
|
|
```
|
||
|
|
|
||
|
|
Build the container image with the following command:
|
||
|
|
|
||
|
|
```Shell
|
||
|
|
docker build --file Containerfile.multiarch --tag thegeeklab/wp-matrix .
|
||
|
|
```
|
||
|
|
|
||
|
|
## Test
|
||
|
|
|
||
|
|
```Shell
|
||
|
|
docker run --rm \
|
||
|
|
-e PLUGIN_ROOMID=0123456789abcdef:matrix.org \
|
||
|
|
-e PLUGIN_USERNAME=yourbot \
|
||
|
|
-e PLUGIN_PASSWORD=p455w0rd \
|
||
|
|
-v $(pwd):/build:z \
|
||
|
|
-w /build \
|
||
|
|
thegeeklab/wp-matrix
|
||
|
|
```
|