Announcerr Github Action

Automatically announce and send emails to list of subscribers on every product release 🚀

Demo Project

Usage

- name: Announcerr
  uses: singhkshitij/announcerr@v2
  with:
    server_address: smtp.gmail.com
    server_port: 465
    username: ${{secrets.MAIL_USERNAME}}
    password: ${{secrets.MAIL_PASSWORD}}
    subject: Launching my awesomeProduct version ${{ github.event.release.tag_name }}
    # Literal body:
    body: Just launched new version of my ${{github.repository}} ! It is fully packed with awesome features.
    # Read file contents as body:
    body: file://README.md
    to: user1@xyz.com,user2@abc.com
    from: Kshitij Singh # <kshitij@mytrashcode.com>
    # Optional content type (defaults to text/plain):
    content_type: text/html
    # Optional attachments:
    attachments: attachments.zip,git.diff,./dist/static/main.js

Caution: Some email server provider such as Gmail do not allow password directly to be used in such apps and might block send message operation, if we try to give plain password directly.

Please follow this guide to generate app password which can then be used…

Announcerr Demo

A demo repo which sends out the changelog email to all the users with the help of Announcer github action whenever a new app version is released ! 🧑‍🚀

How it works ?

• Repo contains a workflow file that gets triggered whenever a release is made.
• This workflow files uses Announcer github action and provides some input to the announcer such as , email username, password and list of users whom to send changelog email.
• Important step is passing the changelog file to the announcer action, which in this case is Demo-page.html 📧.
• Whenever a release is made on repo , announcer gh-action gets tiggered 🚀, reads the changelog file content and sends it to all the users.

PS : To maintain privacy 🔒 Gh-action is reading all the creds and emails from github secrets.