Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
play

GitHub Action

PR review norification

v1.1

PR review norification

play

PR review norification

Notifies users when a review has been addded on a PR

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: PR review norification

              
  uses: isacarvid/PR-review-notification@v1.1
Learn more about this action in isacarvid/PR-review-notification

Choose a version

This GitHub action triggers on a PR review update (comment, requested changes, approve changes).

Setup

Pre-requisites

Insert secrets in to Github secrets. The keys has to be as follows:

EMAIL_USERNAME, eg. name@server.com

EMAIL_PASSWORD, eg. passwordToEmail

EMAIL_DOMAIN, eg. smtp.gmail.com

Inputs

❗ = Required

  Input Description
❗ filePath Path to the readme. Where notification addresses are to be found. Computed by the steps in workflow
❗ usernameSecret The username to the Email to send notifications from. Fetched from secrets.
❗ passwordSecret Password to email to send notification from. Fetched from secrets.
❗ domainSecret smtp server to send email from. Eg. smtp.gmail.com
❗ keyword Keyword to be included in a PR-readme if notification is to be enabled.

Example workflow

name: Some PR
on:
  pull_request_review:
    types: [edited, dismissed, submitted]
jobs:
  notif-prs:
    runs-on: ubuntu-latest
    steps:
      - uses: isacarvid/PR-review-notification
        with:
          usernameSecret: ${{ secrets.EMAIL_USERNAME }}
          passwordSecret: ${{ secrets.EMAIL_PASSWORD }}
          domainSecret: ${{ secrets.EMAIL_DOMAIN }}
          keyword: '#notify'
          ```