awelzel / ci-email-action Goto Github PK

View Code? Open in Web Editor NEW

GitHub action to send email via SMTP on CI check_suite failure

License: BSD 3-Clause "New" or "Revised" License

Python 95.85% Dockerfile 3.47% Makefile 0.67%

ci-email-action's Introduction

ci-email-action

A GitHub action to send email via SMTP on CI check_suite failures.

Failures triggered by Pull Requests do not send email.
The CI App name is configurable, but have only tested with Cirrus CI.
The SMTP / mail configuration requires use of secret variables which can be set within the GitHub repository settings.

Example workflow config:

name: CI Email Notification
on:
  check_suite:
    types: [completed]
jobs:
  notify:
    runs-on: ubuntu-latest
    steps:
      - name: Send CI Email Notification
        uses: jsiwek/ci-email-action@master
        env:
          CI_APP_NAME: "Cirrus CI"
          BRANCH_REGEX: "master|release/.*"
          SKIP_CONCLUSIONS: "neutral,cancelled"
          SMTP_HOST: ${{ secrets.SMTP_HOST }}
          SMTP_PORT: ${{ secrets.SMTP_PORT }}
          SMTP_USER: ${{ secrets.SMTP_USER }}
          SMTP_PASS: ${{ secrets.SMTP_PASS }}
          MAIL_FROM: ${{ secrets.MAIL_FROM }}
          MAIL_TO: ${{ secrets.MAIL_TO }}
          MAIL_REPLY_TO: ${{ secrets.MAIL_REPLY_TO }}
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Except for MAIL_REPLY_TO, BRANCH_REGEX and SKIP_CONCLUSIONS, all environment variables shown in that example are required.

Recommend Projects