https://github.com/losuler/git-notify
Watch a git repo and alert you of new commits.
https://github.com/losuler/git-notify
git linux macos matrix notifications script
Last synced: 3 months ago
JSON representation
Watch a git repo and alert you of new commits.
- Host: GitHub
- URL: https://github.com/losuler/git-notify
- Owner: losuler
- Created: 2021-09-15T04:59:05.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-17T11:07:20.000Z (over 4 years ago)
- Last Synced: 2025-02-08T22:07:07.173Z (12 months ago)
- Topics: git, linux, macos, matrix, notifications, script
- Language: Shell
- Homepage:
- Size: 174 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Git Notify
Watch a git repo and alert you of new commits.
## About
Born from lacking answers after asking about [any tools that can notify about commits to remote git repos on StackOverflow](http://stackoverflow.com/questions/5082001/is-there-a-tool-to-watch-a-remote-git-repository-on-ubuntu-and-do-popup-notificat).
## Installation
Just download `git-notify` and ensure it's folder is located in your path:
```bash
git clone https://github.com/losuler/git-notify
# If you use bash
echo "export PATH=/your/full/path/to/git-notify:\$PATH" >> ~/.bashrc && source ~/.bashrc
# If you use zshrc
echo "export PATH=/your/full/path/to/git-notify:\$PATH" >> ~/.zshrc && source ~/.zshrc
```
## Usage
```
Usage: git-notify [OPTION]...
Watch git repos and be notified upon detection of new commits.
-b BRANCH Specifies the branch to run against (default origin/master)
-r REPOSITORY Specify what repository to watch (default origin/master)
-t TIME Time to wait inbetween checking, in seconds (default 60)
-c PATH Path to the config file
-a Runs the job in the background (via &)
-v Set verbose logging on (adds "[date]: " prefix)
-l Find all git-notify background jobs currently running
-k Kill all backgrounded git-notify jobs
-h Print help and exit
```
Intended to be run from the base of a local cloned Github repository you are interested in monitoring.
## macOS
If you want to change the AppleScript notification type, that is a setting that is controlled in your `System Preferences` ➝ `Notifications` tab. `git-notify` will use the `Script Editor` application, so you should modify those settings.
By default, `Script Editor` uses the `Banners` type message. Switching to the `Alerts` tab will allow for notifications that have a `Close` button to be dismissed individually.
## Acknowledgements
This is based off of the pull request [bigpick/git-notify](https://github.com/jakeonrails/git-notify/pull/12) for the original project at [jakeonrails/git-notify](https://github.com/jakeonrails/git-notify). In the event this pull request gets merged, I would send a pull request of some of my own changes, if they were desired.