https://github.com/appleboy/drone-discord
Drone plugin for sending message to Discord channel using Webhook
https://github.com/appleboy/drone-discord
discord-api discord-bot drone-ci drone-plugin
Last synced: about 21 hours ago
JSON representation
Drone plugin for sending message to Discord channel using Webhook
- Host: GitHub
- URL: https://github.com/appleboy/drone-discord
- Owner: appleboy
- License: mit
- Created: 2017-06-10T02:07:36.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2025-07-05T15:13:50.000Z (3 months ago)
- Last Synced: 2025-09-13T18:47:23.473Z (22 days ago)
- Topics: discord-api, discord-bot, drone-ci, drone-plugin
- Language: Go
- Size: 420 KB
- Stars: 35
- Watchers: 3
- Forks: 20
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# drone-[discord](https://discordapp.com)
[Drone](https://www.drone.io/) / [Woodpecker](https://woodpecker-ci.org/) plugin for sending messages to Discord channels using Webhooks.
[](https://godoc.org/github.com/appleboy/drone-discord)
[](https://codecov.io/gh/appleboy/drone-discord)
[](https://goreportcard.com/report/github.com/appleboy/drone-discord)
[](https://hub.docker.com/r/appleboy/drone-discord/)
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 documentation](https://discordapp.com/developers/docs/resources/webhook). For usage information and a list of available options, please refer to [the documentation](http://plugins.drone.io/appleboy/drone-discord/).
Send Discord messages using a binary, Docker, or [Drone CI](http://docs.drone.io/).
## Features
- [x] Send Multiple Messages
- [x] Send Multiple Files
## Build or Download a binary
The pre-compiled binaries can be downloaded from the [release page](https://github.com/appleboy/drone-discord/releases). The following OS types are supported:
- Windows amd64/386
- Linux arm/amd64/386
- Darwin amd64/386
With `Go` installed:
```sh
go get -u -v github.com/appleboy/drone-discord
```
Or build the binary with the following command:
```sh
export GOOS=linux
export GOARCH=amd64
export CGO_ENABLED=0
export GO111MODULE=on
go test -cover ./...
go build -v -a -tags netgo -o release/linux/amd64/drone-discord
```
## Usage
There are three ways to send notifications:
### Usage from Binary
```bash
drone-discord \
--webhook-id xxxx \
--webhook-token xxxx \
--message "Test Message"
```
### Usage from Docker
```bash
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:
```sh
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=appleboy@gmail.com \
-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
```
## Declarative Environment Config Usage
You can get more [information](DOCS.md) about how to use this plugin in Drone.
```yml
- name: msg status
image: appleboy/drone-discord
settings:
webhook_id:
from_secret: discord_id
webhook_token:
from_secret: discord_token
message: "{{#success build.status}}✅{{else}}❌{{/success}} Repository `[{{repo.name}}/{{commit.branch}}]` triggered by event `[{{uppercase build.event}}]` for build.\n - Commit [[{{commit.sha}}]({{commit.link}})]\n - Author `[{{commit.author}} / {{commit.email}}]`\n - Message: {{commit.message}} - Drone build [[#{{build.number}}]({{build.link}})] reported `[{{uppercase build.status}}]` at `[{{datetime build.finished \"2006.01.02 15:04\" \"\"}}]`\n"
when:
status: [success, failure, changed]
```
```yml
- name: multi line msg status
...
message: >
Line one
Line two
```
## Testing
Test the package with the following command:
```sh
make test
```