https://github.com/eddmann/email-release-notifier
Used at MyBuilder to notify the team upon successful deployment of a GitHub release.
https://github.com/eddmann/email-release-notifier
Last synced: over 1 year ago
JSON representation
Used at MyBuilder to notify the team upon successful deployment of a GitHub release.
- Host: GitHub
- URL: https://github.com/eddmann/email-release-notifier
- Owner: eddmann
- Created: 2020-09-22T07:36:45.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-24T10:06:49.000Z (over 3 years ago)
- Last Synced: 2025-01-23T03:26:48.131Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://tech.mybuilder.com/using-github-actions-to-send-gone-live-release-notes-via-email-and-slack/
- Size: 288 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Email Release Notifier
Used at [MyBuilder](https://www.mybuilder.com/) to notify the team upon successful deployment of a GitHub release.
## Usage
We use [Release Drafter](https://github.com/release-drafter/release-drafter) to compile the release notes based on merged pull requests.
Once this draft release has been published and a successful deployment has occurred, this GitHub Action is invoked which notifies the team via Email of the changes.
```yaml
name: Notify Team via Email about Release
on: deployment_status
jobs:
notify:
if: ${{ github.event.deployment_status.state == 'success' }}
runs-on: ubuntu-20.04
steps:
- name: Notify Team
uses: eddmann/email-release-notifier@v1
with:
to: to@email.com
from: from@email.com
sendGridToken: ${{ secrets.SENDGRID_API_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```
Alternatively, you can emit the notification upon the release being published.
```yaml
name: Notify Team via Email about Release
on:
release:
types: [published]
jobs:
notify:
runs-on: ubuntu-20.04
steps:
- name: Notify Team
uses: eddmann/email-release-notifier@v1
with:
to: to@email.com
from: from@email.com
sendGridToken: ${{ secrets.SENDGRID_API_TOKEN }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```