drone-webhook/README.md

93 lines
2.1 KiB
Markdown
Raw Normal View History

2015-11-03 19:31:25 +00:00
# drone-webhook
2015-11-21 18:01:42 +00:00
Drone plugin for sending Webhook notifications.
2015-11-03 19:31:25 +00:00
## Overview
This plugin is responsible for sending build notifications via Webhooks:
```sh
./drone-webhooks <<EOF
{
"repo" : {
"owner": "foo",
"name": "bar",
"full_name": "foo/bar"
},
"build" : {
"number": 22,
"status": "success",
"started_at": 1421029603,
"finished_at": 1421029813,
"commit": "9f2849d5",
"branch": "master",
"message": "Update the Readme",
"author": "johnsmith",
"author_email": "john.smith@gmail.com"
},
"vargs": {
2015-11-21 18:01:42 +00:00
"urls": ["https://your.webhook/..."],
"debug": true,
"auth": {
"username": "johnsmith",
"password": "secretPass"
},
"headers": {
"SomeHeader": "SomeHeaderValue"
},
"method": "POST",
"template": "{\"git_branch\": \"{{ .Build.Branch }}\"}",
"content_type": "application/json"
2015-11-03 19:31:25 +00:00
}
}
EOF
```
## Docker
Build the Docker container. Note that we need to use the `-netgo` tag so that
the binary is built without a CGO dependency:
```sh
CGO_ENABLED=0 go build -a -tags netgo
docker build --rm=true -t plugins/drone-webhook .
```
Send a Webhook notification:
```sh
docker run -i plugins/drone-webhook <<EOF
{
"repo" : {
"owner": "foo",
"name": "bar",
"full_name": "foo/bar"
},
"build" : {
"number": 22,
"status": "success",
"started_at": 1421029603,
"finished_at": 1421029813,
"commit": "9f2849d5",
"branch": "master",
"message": "Update the Readme",
"author": "johnsmith",
"author_email": "john.smith@gmail.com"
},
"vargs": {
2015-11-21 18:01:42 +00:00
"urls": ["https://your.webhook/..."],
"debug": true,
"auth": {
"username": "johnsmith",
"password": "secretPass"
},
"headers": {
"SomeHeader": "SomeHeaderValue"
},
"method": "POST",
"template": "{\"git_branch\": \"{{ .Build.Branch }}\"}",
"content_type": "application/json"
2015-11-03 19:31:25 +00:00
}
}
EOF
```