Unified documentation and readme

This commit is contained in:
Thomas Boerger
2019-02-15 11:58:36 +01:00
parent cebc6c87f1
commit ec03c4a463
2 changed files with 15 additions and 95 deletions
+15 -8
View File
@@ -12,24 +12,31 @@ Drone plugin to send build status notifications via Webhook. For the usage infor
## Build
Build the binary with the following commands:
Build the binary with the following command:
```
go build
```console
export GOOS=linux
export GOARCH=amd64
export CGO_ENABLED=0
export GO111MODULE=on
go build -v -a -tags netgo -o release/linux/amd64/drone-webhook
```
## Docker
Build the Docker image with the following commands:
Build the Docker image with the following command:
```
GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -a -tags netgo -o release/linux/amd64/drone-webhook
docker build --rm -t plugins/webhook .
```console
docker build \
--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/webhook .
```
### Usage
```
```console
docker run --rm \
-e PLUGIN_URLS=https://hooks.somplace.com/endpoing/... \
-e PLUGIN_HEADERS="HEADER1=value1" \