Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
86 lines (68 sloc) 2.11 KB
date title author url weight menu
2016-01-01 00:00:00 +0000
Example Go Plugin
bradrydzewski
creating-custom-plugins-golang
5
plugin
parent identifier
pipeline
creating-custom-plugins-golang

This guide provides a brief tutorial for creating a webhook plugin, using the Go programming language, to trigger http requests during the build pipeline. The below example demonstrates how we might configure a webhook plugin in the Yaml file:

pipeline:
  webhook:
    image: foo/webhook
    url: http://foo.com
    method: post
    body: hello world

Create a Go program that makes an http request using the Yaml configuration parameters, which are passed to the program as environment variables in uppercase, prefixed with PLUGIN_.

package main

import (
  "net/http"
  "os"
)

func main() {
  body := strings.NewReader(
    os.GetEnv("PLUGIN_BODY"),
  )

  req, err := http.NewRequest(
    os.GetEnv("PLUGIN_METHOD"),
    os.GetEnv("PLUGIN_URL"),
    body,
  )
  if err != nil {
    os.Exit(1)
  }
}

Compile your binary on the host machine for the target platform. Compiling on the host machine and adding the binary to the image is considered a best practice because it reduces the overall image size.

{{% alert warn %}} It is very important to compile using the correct target platform, otherwise your plugin will fail with a cryptic Go runtime error. {{% /alert %}}

GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -o webhook

Create a Dockerfile that adds your compiled binary to the image, and configures the image to run your binary as the main entrypoint.

FROM alpine
ADD webhook /bin/
RUN apk -Uuv add ca-certificates
ENTRYPOINT /bin/webhook

Build and publish your plugin to the Docker registry. Once published your plugin can be shared with the broader Drone community.

docker build -t foo/webhook .
docker push foo/webhook

Execute your plugin locally from the command line to verify it is working:

docker run --rm \
  -e PLUGIN_METHOD=post \
  -e PLUGIN_URL=http://foo.com \
  -e PLUGIN_BODY="hello world" \
  foo/webhook