This repo contains a re-usable GitHub Action that when installed sends an e-mail to a distribution list with the release notes every time a GitHub Release is created for the repository.
This Action makes use of SendGrid's API to send the e-mails.
To run this action you'll need:
- A SendGrid API Key. SendGrid is free to up 100 e-mails a day so feel free to register and get your API KEY.
- A text file hosted anywhere with the list of e-mail recipients. You can use GitHub Gists and get the link of the raw file.
Add a new YML file workflow in .github/workflows to trigger on release. For example:
name: E-Mail Release Notification
on:
release:
types: [published]
jobs:
notify:
runs-on: ubuntu-latest
steps:
- name: Notify about a new release
uses: ba-st-actions/[email protected]
env:
SENDGRID_API_TOKEN: ${{ secrets.SENDGRID_API_TOKEN }}
RECIPIENTS_URL: ${{ secrets.RECIPIENTS_URL }}
SENDER_EMAIL: ${{ secrets.SENDER_EMAIL }}
DISTRIBUTION_LISTS: ${{ secrets.DISTRIBUTION_LISTS }}Create a new secret on your project named SENDGRID_API_TOKEN. Set the value to your SendGrid API Key.
Do the same for a secret named RECIPIENTS_URL that you need to set to the URI of the text file with the target recipients. The contents of the file should be a list of e-mails separated by newlines, for example:
If you don't know where to host this file, just go to GitHub Gists and create a new textfile with the e-mails you want to target. After you save the file just click raw and get the URI of the file you've just created.
Do the same for a secret named DISTRIBUTION_LISTS. The secret contents is a comma separated list of e-mails for other lists (This e-mails will be put in CC in the outgoing mail).
Do the same for a secret named SENDER_EMAIL including the e-mail to be used in the from: field on the mail message.
Create a new release for your repository and verify that the action triggers and that the e-mails were sent. Sometimes it's worth checking the spam inbox.