Skip to content

blajda-dev/TeamsFileNotifier

Repository files navigation


TeamsFileNotifier

A simple tray app to notify your team members when new files are ready for deployment
Explore the docs »

Download · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

(back to top)

Built With

These frameworks cam in mighty handy getting this project off the ground.

(back to top)

Getting Started

If you are interested in contributing, just clone the repo and start making changes in a fork and fire a pull request. To use the notifier, go to the Installation section!

Prerequisites

No pre-requisites!! The notifier is a completely self contained .exe

To actually contribute there may be some additional repos you may need to download via Nuget

Installation

Go to releases -> Releases and download the latest .exe notifier. You may need to sign in with your Microsoft account with will authenticate against the API and request some permissions to post on your behalf. Once you've done that you can configure the app.

  1. Find Tray Icon
  2. Click "Edit Config"
  3. Configure your directories, teams & extensions
  4. Save the config and exit
  5. Profit

(back to top)

Usage

shown below is an example of a config file json that you could use to monitor folders, with sensitive information removed.

  • path
    • the path you want to monitor for file changes on your computer
  • webhook
    • a link to a microsoft teams channel
    {
     "folders": [
        {
            "path":"D:/WORK/AUDIO",
            "webhook":"https://link-to-teams-channel",
            "extensions" : [
                { "extension":".qsys" }, { "extension":".lpz" }, { "extension":".txt" }, 
                { 
                    "extension":".vtz", 
                    "custom_action":
                    {
                        "notify_team_members": ["auser"]
                    }
                }
            ]
        },
        {
            "path":"D:\\Example Folder 2\\Documents",
            "webhook":"https://link-to-teams-channel",
            "extensions" : [
                { "extension":".txt" }, 
                { 
                    "extension":".json",
                    "custom_action":
                    {
                        "notify_team_members": ["buser"]
                    }
                }
            ]
        },
        {
            "webhook":"https://link-to-teams-channel",
            "path":"D:/Example Folder/PROGRAMMING",
             "extensions" : [
                { 
                    "extension":".lpz",
                    "custom_action":
                    {
                        "notify_team_members": ["cuser"]
                    }
                },
                {
                    "extension":".vtz",
                    "custom_action":
                    {
                        "notify_team_members": ["cuser"]
                    }
                }
             ]
        }
     ]   
    }
    

(back to top)

Roadmap

  • Add Changelog
  • Add back to top links
  • Add "Custom Action" feature to incorporate custom text actions, like tagging people into the content of the card so the right folks get notified

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Top contributors:

Contributors

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Ryan Blajda - rblajda@ccsnewengland.com

Project Link: https://github.com/ryanjblajda/TeamsFileNotifier

(back to top)

About

a file monitor that posts to teams

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages