Email notifications for Sloth CI builds
Project description
Email Notifications for Sloth CI Builds
Send email notifications when builds complete or fail.
Executing actions of an app is called build. A build is considered completed if all its actions were completed. If some actions were completed and some failed, it's a partially completed; if all actions fail, the build failed.
This extension sends you emails via SMTP when your builds complete (fully or partially) or fail; just pick the desired notification level, list the recipient emails, and enter your SMTP credentials. Optionally, you can set the subject for each notification level.
Installation
$ pip install sloth-ci-ext-notifications
Usage
extensions:
notifications:
# Use the module sloth_ci_ext_notifications.
module: notifications
# Emails to send the notifications to.
emails:
- foo@bar.com
- admin@example.com
# Log level (number or valid Python logging level name).
# ERROR includes only build fails, WARNING adds partial completions,
# INFO adds completion, and DEBUG adds trigger notifications.
# Default is WARNING.
level: INFO
# The "from" address in the emails. Default is "build@sloth.ci."
from: notify@example.com
# The email subject on build trigger. You can use the {listen_point} placeholder.
# Default is "{listen_point}: Build Triggered."
subject_triggered: 'Triggered build on {listen_point}!'
# The email subject on build completion.You can use the {listen_point} placeholder.
# Default is "{listen_point}: Build Completed."
subject_completed: 'Hooray! {listen_point} works!'
# The email subject on build partial completion. You can use the {listen_point} placeholder.
# Default is "{listen_point}: Build Partially Completed."
subject_partially_completed: 'Better than nothing on {listen_point}'
# The email subject on build fail. You can use the {listen_point} placeholder.
# Default is "{listen_point}: Build Failed."
subject_failed: 'Fail on {listen_point}'
# SMTP settings.
# SMTP mail host and (if not default) port.
# Mandatory parameter.
mailhost: 'smtp-mail.outlook.com:25'
# SMTP login.
login: foo@bar.baz
# SMTP password.
password: bar
# If the SMTP server requires TLS, set this to true. Default is false.
# If necessary, you can provide a keyfile name or a keyfile and a certificate file names.
# This param is used only if the login and password params are supplied.
secure: true
# secure:
# - keyfile
# - cerfile
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for sloth-ci-ext-notifications-1.0.8.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cb937a32cab60a05dae9bebab41cf6bf23a6fecd1794cc6a32a8be3cfe211cea |
|
MD5 | e860991e194f581a77f9358f90a0cc4b |
|
BLAKE2b-256 | f27d262ecafe8156d45d88015a27d7932262ea8873f4e126b9fd36251a51adff |
Close
Hashes for sloth_ci_ext_notifications-1.0.8-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e8eb5c407faf0133f434680d321aefe9ea811d5cdde603f408c3d04253f934a6 |
|
MD5 | f081f6f085a47106bc084815cbe4b6e7 |
|
BLAKE2b-256 | b0323db613c4c44b12ca4c3c4fc731525f86db2e86d573b6308e4e15309766d8 |