deblan/woodpecker-email
deblan/woodpecker-email
1
0
Fork 0
Code Issues 1 Pull requests Packages Projects Releases Wiki Activity
woodpecker-email/DOCS.md
Thomas Boerger 8484730b82 Integrated skip verify, gomail and templates 
I have switched the mail sending mechanism to gomail to get more power
out of the sending method. Beside that I have added a flag to skip
certificate verification.

On top of that I have integrated the drone templating to make it
possible to overwrite the email templates optionally.

To be more compatible I have created a plaintext message format with the
help of html2text as well.
2016-02-01 12:55:41 +01:00

2.4 KiB
Raw Blame History

Use this plugin for sending build status notifications via Email. You can override the default configuration with the following parameters:

  • from - Send notifications from this address
  • host - SMTP server host
  • port - SMTP server port, defaults to 587
  • username - SMTP username
  • password - SMTP password
  • recipients - List of recipients, defaults to commit email

Example

The following is a sample configuration in your .drone.yml file:

notify:
  email:
    from: noreply@github.com
    host: smtp.mailgun.org
    username: octocat
    password: 12345
    recipients:
      - octocat@github.com

Custom Templates

In some cases you may want to customize the look and feel of the email message so you can use custom templates. For the use case we expose the following additional parameters, all of the accept a custom handlebars template, directly provided as a string or as a remote URL which gets fetched and parsed:

  • subject - A handlebars template to create a custom subject. For more details take a look at the docs. You can see the default template here
  • template - A handlebars template to create a custom template. For more details take a look at the docs. You can see the default template here

Example configuration that generate a custom email:

notify:
  email:
    from: noreply@github.com
    host: smtp.mailgun.org
    username: octocat
    password: 12345
    recipients:
      - octocat@github.com
    subject: >
      [{{ build.status }}]
      {{ repo.owner }}/{{ repo.name }}
      ({{ build.branch }} - {{ truncate build.commit 8 }})      
    template: >
      https://git.io/vgvPz

Skip SSL verify

In some cases you may want to skip SSL verification, even if we discourage that as it leads to an unsecure environment. Please use this option only within your intranet and/or with truested resources. For this use case we expose the following additional parameter:

  • skip_verify - Skip verification of SSL certificates

Example configuration that skips SSL verification:

notify:
  email:
    from: noreply@github.com
    host: smtp.mailgun.org
    username: octocat
    password: 12345
    skip_verify: true
    recipients:
      - octocat@github.com