drone-bash-plugin

Example Bash Plugin for Drone CI/CD service.

How to write bash plugin

This provides a brief tutorial for creating a Drone webhook plugin, using simple shell scripting, to make an 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 simple shell script that invokes curl using the Yaml configuration parameters, which are passed to the script as environment variables in uppercase and prefixed with PLUGIN_.

#!/bin/sh

curl \
  -X ${PLUGIN_METHOD} \
  -d ${PLUGIN_BODY} \
  ${PLUGIN_URL}

Create a Dockerfile that adds your shell script to the image, and configures the image to execute your shell script as the main entrypoint.

FROM alpine
ADD post.sh /bin/
RUN chmod +x /bin/post.sh
RUN apk -Uuv add curl ca-certificates
ENTRYPOINT /bin/post.sh

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 .
# login your dockerhub account.
$ docker login
$ 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=https://postman-echo.com/post \
  -e PLUGIN_BODY="hello=world" \
  foo/webhook

Result:

{"args":{},"data":"","files":{},"form":{"hello":"world"},"headers":{"host":"postman-echo.com","content-length":"11","accept":"*/*","content-type":"application/x-www-form-urlencoded","user-agent":"curl/7.52.1","x-forwarded-port":"443","x-forwarded-proto":"https"},"json":{"hello":"world"},"url":"https://postman-echo.com/post"}