c2h5oh / drone-discord

Drone plugin for sending message to Discord channel using Webhook

drone-discord

Drone plugin for sending message to Discord channel using Webhook.

Webhooks are a low-effort way to post messages to channels in Discord. They do not require a bot user or authentication to use. See more api document information.

Sending discord message using a binary, docker or Drone CI.

Build or Download a binary

The pre-compiled binaries can be downloaded from release page. Support the following OS type.

• Windows amd64/386
• Linux amd64/386
• Darwin amd64/386

With Go installed

$ go get -u -v github.com/appleboy/drone-discord

or build the binary with the following command:

$ make build

Docker

Build the docker image with the following commands:

$ make docker

Please note incorrectly building the image for the correct x64 linux and with CGO disabled will result in an error when running the Docker image:

docker: Error response from daemon: Container command
'/bin/drone-discord' not found or does not exist..

Usage

There are three ways to send notification.

• usage from binary
• usage from docker
• usage from drone ci

Usage from binary

Send Notification

drone-discord \
  --webhook-id xxxx \
  --webhook-token xxxx \
  --message "Test Message"

Usage from docker

Send Notification

docker run --rm \
  -e WEBHOOK_ID=xxxxxxx \
  -e WEBHOOK_TOKEN=xxxxxxx \
  -e WAIT=false \
  -e TTS=false \
  -e USERNAME=test \
  -e AVATAR_URL=http://example.com/xxxx.png \
  -e MESSAGE=test \
  appleboy/drone-discord

Usage from drone ci

Send Notification

Execute from the working directory:

docker run --rm \
  -e WEBHOOK_ID=xxxxxxx \
  -e WEBHOOK_TOKEN=xxxxxxx \
  -e WAIT=false \
  -e TTS=false \
  -e USERNAME=test \
  -e AVATAR_URL=http://example.com/xxxx.png \
  -e MESSAGE=test \
  -e DRONE_REPO_OWNER=appleboy \
  -e DRONE_REPO_NAME=go-hello \
  -e DRONE_COMMIT_SHA=e5e82b5eb3737205c25955dcc3dcacc839b7be52 \
  -e DRONE_COMMIT_BRANCH=master \
  -e DRONE_COMMIT_AUTHOR=appleboy \
  -e DRONE_COMMIT_AUTHOR_EMAIL=[e-mail] \
  -e DRONE_COMMIT_MESSAGE=Test_Your_Commit \
  -e DRONE_BUILD_NUMBER=1 \
  -e DRONE_BUILD_STATUS=success \
  -e DRONE_BUILD_LINK=http://github.com/appleboy/go-hello \
  -e DRONE_JOB_STARTED=1477550550 \
  -e DRONE_JOB_FINISHED=1477550750 \
  -v $(pwd):$(pwd) \
  -w $(pwd) \
  appleboy/drone-discord

You can get more information about how to use this plugin in drone.

Testing

Test the package with the following command:

$ make test