Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bitoiu/release-notify-action

GitHub Action that triggers e-mails with release notes when these are created
https://github.com/bitoiu/release-notify-action

email-sender github github-actions github-releases mailer notify sendgrid workflow

Last synced: 22 days ago
JSON representation

GitHub Action that triggers e-mails with release notes when these are created

Host: GitHub
URL: https://github.com/bitoiu/release-notify-action
Owner: bitoiu
License: mit
Created: 2018-10-11T19:53:59.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2022-12-08T03:01:18.000Z (almost 2 years ago)
Last Synced: 2024-08-01T16:36:09.524Z (3 months ago)
Topics: email-sender, github, github-actions, github-releases, mailer, notify, sendgrid, workflow
Language: JavaScript
Homepage:
Size: 35.2 KB
Stars: 65
Watchers: 3
Forks: 17
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

## release-notify-action

This repo contains a re-usable GitHub Action that when installed sends an e-mail to a distribution list with the release note contents every time a GitHub Release is created for the repository.

This Action makes use of [SendGrid's](https://sendgrid.com/) API to send the e-mails.

## Pre-requisites

To run this action you'll need:
- To be part of the [Actions beta](https://github.com/features/actions). Note that during the beta, Actions will only run on private repositories.
- A [**SendGrid API Key**](https://sendgrid.com/docs/ui/account-and-settings/api-keys/). _SendGrid is [free to up 100 e-mails a day](https://sendgrid.com/pricing/) so feel free to register and get your API KEY._
- **A text file hosted anywhere** with the list of e-mail recipients. _I personally use [GitHub Gists](https://gist.github.com) and get the link of the raw file._

## Setup

### 1. Create the release workflow

Add a new workflow to your `.github/main.workflow` to trigger on `release`.

new-workflow

### 2. Create the Action

Create an action that uses this repository `bitoiu/release-notify-action@master` or points to Docker Hub at `docker://bitoiu/release-notifiy-action`

new-action

### 3. Set the SendGrid secret

Using the Visual Editor create a new secret on the action named `SENDGRID_API_TOKEN`. Set the value to your [SendGrid API Key](https://sendgrid.com/docs/ui/account-and-settings/api-keys/).

new-secret

### 4. Set the RECIPIENTS secret

Do the same for a secret named `RECIPIENTS` 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 newline, for example:

```
[email protected]
[email protected]
```

If you don't know where to host this file, just go to [GitHub Gists](https://gist.github.com) 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.

### 5. Commit the changes

Make sure you commit all pending changes. After you've done that your `main.workflow` should look similar to this:

```

workflow "Release Notifier" {
on = "release"
resolves = ["Notify Releases"]
}

action "Notify Releases" {
uses = "bitoiu/release-notify-action@master"
secrets = ["SENDGRID_API_TOKEN", "RECIPIENTS"]
}

```

On the visual editor it should look similar to this:

![visual editor](https://user-images.githubusercontent.com/1192590/47112717-10bef700-d24f-11e8-86a7-ef28d3d270c8.png)

### 6. Test the workflow!

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.

## Local testing

The main script that does the heavy lifting is a NodeJS file. As such you can simply test it like any other node program, for example, running the following inside the `src` folder:

```
SENDGRID_API_TOKEN=XXX RECIPIENTS=ABSOLUTE_PATH_TO_TXT_FILE_WITH_RECIPIENTS GITHUB_EVENT_PATH=ABSOLUTE_PATH_TO_SAMPLE_PAYLOAD_FILE_PROVIDED node notify.js
```

If you prefer to test the container directly (which is a tiny bit slower but more reliable) you can just run something like:

```
docker build -t release . && docker run --env-file=./env release
```

Be sure to rename `env.template` to `env` and fill it with your environment variables.

## Pull Requests and Issues are Welcome

If you're thinking of a dynamic e-mail template with substitutions, configurable TO and FROM addresses then you're just a pull request away. Feel free to share your ideas.

:octocat::heart: