Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kolbasa/git-repo-watcher
A simple bash script to watch a git repository and pull upstream changes if needed.
https://github.com/kolbasa/git-repo-watcher
bash daemon fetcher git github interval notify pull remote repo repository shell sync synchronizer up-to-date updater upstream watch watcher windows
Last synced: 3 months ago
JSON representation
A simple bash script to watch a git repository and pull upstream changes if needed.
- Host: GitHub
- URL: https://github.com/kolbasa/git-repo-watcher
- Owner: kolbasa
- License: mit
- Created: 2017-02-01T18:20:51.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-16T17:52:04.000Z (about 2 years ago)
- Last Synced: 2024-08-02T16:06:41.843Z (6 months ago)
- Topics: bash, daemon, fetcher, git, github, interval, notify, pull, remote, repo, repository, shell, sync, synchronizer, up-to-date, updater, upstream, watch, watcher, windows
- Language: Shell
- Homepage:
- Size: 40 KB
- Stars: 171
- Watchers: 10
- Forks: 35
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Git Repo Watcher
A simple bash script to watch a git repository and pull upstream changes if available.
### Requirements
* Bash with Version > 3
* Tested on Ubuntu, Debian, MacOS, [Windows Git Shell](https://git-scm.com/download/win), [Windows Subsystem for Linux (WSL)](https://www.microsoft.com/en-us/p/ubuntu/9nblggh4msv6)
Basically, it will work anywhere you can install Bash.
If something doesn't work, please [let me know](https://github.com/kolbasa/git-repo-watcher/issues).
### Usage
You only need the path to your git repository to start.
Make sure your local repository is tracking a remote branch, otherwise the script will fail.
This will start a watcher that looks for changes every 10 seconds:
```bash
./git-repo-watcher -d "/path/to/your/repository"
```
The time interval can be changed by passing it to `-i` (seconds):
```bash
./git-repo-watcher -d "/path/to/your/repository" -i 60
```
You can also turn off the watcher by passing `-o`.
This will execute the script only once.
```bash
./git-repo-watcher -d "/path/to/your/repository" -o
```
### Customizations
You can add your own logic to the file: [`git-repo-watcher-hooks`](https://github.com/kolbasa/git-repo-watcher/blob/master/git-repo-watcher-hooks)
For example, you can start your build process in case of changes:
```bash
# $1 - Git repository name
# $2 - Branch name
# $3 - Commit details
change_pulled() {
echo "Starting build for commit: $@"
./your-build-script.sh
}
```
If you have more than one repository you can pass a copy of the `git-repo-watcher-hooks` file like so:
```bash
./git-repo-watcher -d "/path/to/your/repository" -h "/path/to/your/hooks-file"
```
### Private repositories
The script works with private repositories.
First configure a password cache with `git config --global credential.helper "cache --timeout=60"`.
Make sure the `timeout` is greater than the time interval given to the script. Both are given as seconds.
The program will execute `git fetch` and ask for your login data. The script itself **does not** store passwords!
If you want it to run in the background as a daemon process, you have to execute `git fetch` beforehand.
Example code:
```bash
cd "/path/to/your/repository"
git config --global credential.helper "cache --timeout=60"
git fetch
# Checking exit code
if [[ $? -eq 1 ]]; then
echo "Wrong password!" >&2
exit 1
fi
# Disown process
./git-repo-watcher -d "/path/to/your/repository" > "/path/to/your/logfile.log" & disown
```
### Windows 10
The easiest way is to install [Git Shell](https://git-scm.com/download/win), which also comes with bash.
The only thing you have to consider are the file separators. The Unix format should be used here:
`C:\YourGitRepository` → `/C/YourGitRepository`
It is a little more difficult with [WSL](https://www.microsoft.com/en-us/p/ubuntu/9nblggh4msv6).
This must first be installed and configured via the Windows Store.
The file structure is also slightly different:
`C:\YourGitRepository` → `/mnt/c/YourGitRepository`
### Tests
The test suite [`git-repo-watcher-tests`](https://github.com/kolbasa/git-repo-watcher/blob/master/git-repo-watcher-tests) is using the test framework [shunit2](https://github.com/kward/shunit2), it will be downloaded automatically to your `/tmp` folder.
The script has no other dependencies and requires no internet connection.
The tests create several test git repositories in the folder: `/tmp/git-repo-watcher`.
A git user should be configured, otherwise the tests will fail.
With the following line you can check if this is the case:
```bash
git config --list
```
You can configure it as follows:
```bash
git config --global user.email "[email protected]"
git config --global user.name "Your Name"
```