https://github.com/danthe1st/email-filechange-notif-action

This action allows you to notify users once a file is changed
https://github.com/danthe1st/email-filechange-notif-action

email-notification github-action github-actions github-actions-docker

Last synced: 3 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/danthe1st/email-filechange-notif-action
• Owner: danthe1st
• License: gpl-3.0
• Created: 2021-07-31T13:28:58.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2021-08-01T10:02:32.000Z (almost 4 years ago)
• Last Synced: 2025-03-24T11:56:53.011Z (3 months ago)
• Topics: email-notification, github-action, github-actions, github-actions-docker
• Language: Shell
• Homepage: https://stackoverflow.com/questions/68533378/github-file-change-notifications
• Size: 25.4 KB
• Stars: 4
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# 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: 

```yaml

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.