GitHub Action to send emails for Check Suites
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
cmd
internal
testdata
.gitignore
Dockerfile
LICENSE
README.md
go.mod
go.sum

README.md

Send Emails with GitHub Actions

Build Status

This is a simple GitHub action that allows to send emails when a GitHub Check Suite completes. This requires a few environment variables:

  • APP_NAME - Name of an application for which to send emails for.
  • MAIL_FROM - email address to send emails from.
  • MAIL_HOST - SMTP host to send emails to.
  • MAIL_USERNAME and MAIL_PASSWORD - username and password to authorize with the SMTP server.
  • GITHUB_TOKEN - is standard environment variable for GitHub actions.
  • optional IGNORED_CONCLUSIONS to secify conclusions to report. By default only success and neutral checks are ignored.

Now your action can look liker this in your .github/main.workflow workflow file:

action "Cirrus CI Email" {
  uses = "docker://cirrusactions/email:latest"
  env = {
    APP_NAME = "Cirrus CI"
  }
  secrets = ["GITHUB_TOKEN", "MAIL_FROM", "MAIL_HOST", "MAIL_USERNAME", "MAIL_PASSWORD"]
}