mirror of
https://github.com/thegeeklab/drone-matrix.git
synced 2024-11-21 18:10:39 +00:00
Unified documentation and readme
This commit is contained in:
parent
0127eb1730
commit
08137c6e18
25
README.md
25
README.md
@ -12,24 +12,31 @@ Drone plugin for sending build notifications to [Matrix](https://matrix.org/). F
|
|||||||
|
|
||||||
## Build
|
## Build
|
||||||
|
|
||||||
Build the binary with the following commands:
|
Build the binary with the following command:
|
||||||
|
|
||||||
```
|
```console
|
||||||
go build
|
export GOOS=linux
|
||||||
|
export GOARCH=amd64
|
||||||
|
export CGO_ENABLED=0
|
||||||
|
export GO111MODULE=on
|
||||||
|
|
||||||
|
go build -v -a -tags netgo -o release/linux/amd64/drone-matrix
|
||||||
```
|
```
|
||||||
|
|
||||||
## Docker
|
## Docker
|
||||||
|
|
||||||
Build the Docker image with the following commands:
|
Build the Docker image with the following command:
|
||||||
|
|
||||||
```
|
```console
|
||||||
GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -a -tags netgo -o release/linux/amd64/drone-matrix
|
docker build \
|
||||||
docker build --rm -t plugins/matrix .
|
--label org.label-schema.build-date=$(date -u +"%Y-%m-%dT%H:%M:%SZ") \
|
||||||
|
--label org.label-schema.vcs-ref=$(git rev-parse --short HEAD) \
|
||||||
|
--file docker/Dockerfile.linux.amd64 --tag plugins/matrix .
|
||||||
```
|
```
|
||||||
|
|
||||||
### Usage
|
## Usage
|
||||||
|
|
||||||
```
|
```console
|
||||||
docker run --rm \
|
docker run --rm \
|
||||||
-e PLUGIN_ROOMID=0123456789abcdef:matrix.org \
|
-e PLUGIN_ROOMID=0123456789abcdef:matrix.org \
|
||||||
-e PLUGIN_USERNAME=yourbot \
|
-e PLUGIN_USERNAME=yourbot \
|
||||||
|
Loading…
Reference in New Issue
Block a user