drone-matrix/_docs/_index.md

2.1 KiB

title
drone-matrix

Build Status Docker Hub Quay.io GitHub contributors Source: GitHub License: MIT

Drone plugin to to send messages to a Matrix room.

{{< toc >}}

Build

Build the binary with the following command:

export GOOS=linux
export GOARCH=amd64
export CGO_ENABLED=0
export GO111MODULE=on

make build

Build the Docker image with the following command:

docker build --file docker/Dockerfile.amd64 --tag thegeeklab/drone-matrix .

Usage

docker run --rm \
  -e PLUGIN_ROOMID=0123456789abcdef:matrix.org \
  -e PLUGIN_USERNAME=yourbot \
  -e PLUGIN_PASSWORD=p455w0rd \
  -v $(pwd):$(pwd) \
  -w $(pwd) \
  thegeeklab/drone-matrix

Parameters

username
sets username for authentication
password
sets password for authentication
user_id
sets userid for authentication
access_token
sets access token for authentication
homeserver
sets matrix home server url to use (default https://matrix.org)
roomid
sets roomid to send messages to
template
sets message template; used default template build {{ build.status }} [{{ repo.owner }}/{{ repo.name }}#{{ truncate build.commit 8 }}]({{ build.link }}) ({{ build.branch }}) by {{ build.author }}