GitXplorerGitXplorer
d

email-filechange-notif-action

public
4 stars
3 forks
0 issues

Commits

List of commits on branch master.
Verified
463b2b29d108ef16512f3374a46d9c48cad770a9

v1 instead of master

ddanthe1st committed 3 years ago
Verified
8165a2f32cf7aac909ca43dca89467ef7ae456ba

remove debug output

ddanthe1st committed 3 years ago
Verified
820a9a5a27b5f5ff446d2f4e8c08e18e0ce8a09f

add file pattern to gitignore before checking

ddanthe1st committed 3 years ago
Verified
402657c42b5015414598e826aaeb1847f1c13238

add more details to E-Mail

ddanthe1st committed 3 years ago
Verified
fd8316a427c2a52c6c0488d7f323b5a80ecaebbf

remove left over debug output

ddanthe1st committed 3 years ago
Verified
77ed08097114bbd2caac6c5f2381279bf6c2571b

initial commit

ddanthe1st committed 3 years ago

README

The README file for this repository.

email-filechange-notif-action

This action allows you to notify users once a file is changed

How To Use

For using this action, you need to create a workflow file like this:

name: 'Notify users on file change'
on:
  push:
    branches: [ master ]
jobs:
  notif:
    runs-on: ubuntu-latest
    steps:
      - uses: danthe1st/email-filechange-notif-action@v1
        with: 
          # Address to send E-Mails from
          senderEmail: ${{ secrets.SENDER_EMAIL }}
          # optional, The subject of the E-Mails to send
          subjectLine: 'GitHub file change notification'
          # A file in the repository or HTTP address that contains file patterns with E-Mail addresses that should be notified on file changes
          mailingList: ${{ secrets.MAILING_LIST }}
          # The SMTP server used to send E-Mails
          smtpServer: ${{ secrets.SMTP_SERVER }}
          # optional, The SMTP port used to send E-Mails
          smtpPort: 587
          # The SMTP user name used to send E-Mails
          smtpUsername: ${{ secrets.SMTP_USER }}
          # The SMTP password used to send E-Mails
          smtpPassword: ${{ secrets.SMTP_PASSWORD }}

This file should be located in the directory .github/workflows and the file ending should be .yml.

The secrets can be configured in the Settings tab of the GitHub repository under Secrets.

The input mailingList can either be the path to a file in the repository or a HTTP(s) link to such a file. Every line in this file consists of a file pattern (gitignore format) followed by one space and an E-Mail address. If the workflow is executed and a file matching the pattern is changed, an E-mail should be sent to the address configured.