deblan/woodpecker-email
deblan/woodpecker-email
1
0
Fork 0
Code Issues 1 Pull requests Packages Projects Releases Wiki Activity

Streamlined the documentation

Browse source
This commit is contained in:
Thomas Boerger 2015-12-11 09:44:27 +01:00
parent 9c566da9a2
commit 07a1259df4
2 changed files with 66 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
DOCS.md
View file

@ -1,20 +1,22 @@
Use the Email plugin to send an email to a recipient list when a build completes. The following parameters are used to configure the email plugin: Use this plugin for sending build status notifications via Email. You can
override the default configuration with the following parameters:
* `from` - sends email from this address * `from` - Send notifications from this address
* `host` - smtp server host * `host` - SMTP server host
* `port` - smtp server port (defaults to `587`) * `port` - SMTP server port, defaults to `587`
* `username` - smtp server username * `username` - SMTP username
* `password` - smtp server password * `password` - SMTP password
* `recipient` - list of email recipients (defaults to commit email) * `recipients` - List of recipients, defaults to commit email
Same email configuration: ## Example
The following is a sample configuration in your .drone.yml file:
```yaml ```yaml
notify: notify:
email: email:
from: noreply@github.com from: noreply@github.com
host: smtp.mailgun.org host: smtp.mailgun.org
port: 587
username: octocat username: octocat
password: 12345 password: 12345
recipients: recipients:

60
README.md
View file

@ -1,12 +1,13 @@
# drone-email # drone-email
Drone plugin for sending email notifications. [![Build Status](http://beta.drone.io/api/badges/drone-plugins/drone-email/status.svg)](http://beta.drone.io/drone-plugins/drone-email)
[![](https://badge.imagelayers.io/plugins/drone-email:latest.svg)](https://imagelayers.io/?images=plugins/drone-email:latest 'Get your own badge on imagelayers.io')
## Overview Drone plugin for sending build status notifications via Email
This plugin is responsible for sending build notifications via email: ## Usage
``` ```sh
./drone-email <<EOF ./drone-email <<EOF
{ {
"repo" : { "repo" : {
@ -34,7 +35,56 @@ This plugin is responsible for sending build notifications via email:
"port": 587, "port": 587,
"username": "", "username": "",
"password": "", "password": "",
"recipients": ["octocat@github.com"] "recipients": [
"octocat@github.com"
]
}
}
EOF
```
## Docker
Build the Docker container using `make`:
```sh
make deps build
docker build --rm=true -t plugins/drone-email .
```
### Example
```sh
docker run -i plugins/drone-email <<EOF
{
"repo" : {
"owner": "foo",
"name": "bar",
"full_name": "foo/bar"
},
"system": {
"link_url": "http://drone.mycompany.com"
},
"build" : {
"number": 22,
"status": "success",
"started_at": 1421029603,
"finished_at": 1421029813,
"commit": "64908ed2414b771554fda6508dd56a0c43766831",
"branch": "master",
"message": "Update the Readme",
"author": "johnsmith",
"author_email": "john.smith@gmail.com"
},
"vargs": {
"from": "noreply@foo.com",
"host": "smtp.mailgun.org",
"port": 587,
"username": "",
"password": "",
"recipients": [
"octocat@github.com"
]
} }
} }
EOF EOF