An indicator for the Unity panel that show sync percentage of all your git repositories in your home directory. You can use it to show information about the origin/master branch compare to your local master one.
git-indicator makes fetch and diff from master to origin/master for each repository in order to check differences.
Panel showing synchronisation in progress.
Panel showing total synchronisation of repositories.
Panel showing synchronisation of each repositories.
Panel showing notification for repositories which have new commits.
The goal is to have some quick synchronisation information about your Git repositories.
From developper point of view, you always need to know if your (or external) repositories are up to date or not. Thus I decided to develop a Gnome indicator to notice the current user if origin branches have new commits.
There is still room for improvement.
To prepare the install
$ sudo apt-get install libgtk-2-dev libappindicator2-dev libssh2-1-dev libgit2-dev libnotify-dev
$ git clone https://github.com/ubikz/git-indicator.git
$ cd git-indicatorYou may need to compile the libgit2 dependencie yourself
I always try to use the last stable version of libgit; you can get it (here). Follow this to compile the lib. If you notice that some protypes changed because git-indicator is not up to date with libgit, just let me know by creating a new issue.
To install git-indicator
$ make configure
$ make
$ sudo make installTo clean and uninstall git-indicator
$ make clean
$ sudo make uninstallLast two steps in a single one (quick way)
$ ./scripts/buildUbuntu uses .desktop files to manage autostart. You may use the one provided
with the sources.
The make install will copy the destkop autostart file
The install creates a bash script: /usr/local/bin/git-indicator. It is a service-like script.
You can manage the indicator with {start|restart|stop|status} commands.
The makefile creates default configuration looking for *.git repositories in your home folder.
That's the goal of these commands:
find ~/ -type d -name '*.git' | sed "s/\.git//g" | \
egrep -v '(bundle|tests|vendor|.composer)' > ~/.$(NAME)/.confYou can see with egrep -v that we're excluding some folders name (dependency repositories).
You can change the $HOME/.git-indicator/.conf file, but you need to restart the service.
How to test manually the difference between branches for a repository
You can simulate Git-Indicator feature for a repository:
$ cd $HOME/path/to/my/gitrepository
$ git fetch
$ git rev-list master..origin/master --countIf stdout = 0, then your local master is up to date; otherwise there are commits above your local branch.
You may like (at some point) disable some features because you do not want use credentials, catch errors or display OSD notifications. Thus I added bits field option to provide this.
Here a table of current options
| Code | b2 | b10 | Description |
|---|---|---|---|
| MASK_LOOP | 0000 0001 | 1 | Enable the main loop in listen thread |
| MASK_DEBUG | 0000 0010 | 2 | Enable debug mode (print in stdout) |
| MASK_FETCH_AUTO | 0000 0100 | 4 | Enable automatic fetch mode (libgit) else manual one |
| MASK_FETCH_CREDENTIALS | 0000 1000 | 8 | Use default ssh key credentials for private repositories |
| MASK_UPDATE_INDICATOR | 0001 0000 | 16 | Enable timeout for indicator update |
| MASK_APPEND_OSD | 0010 0000 | 32 | Display OSD notifications |
| MASK_ASREAD_OSD | 0100 0000 | 64 | Mark OSD notifs as read |
Defaulting
- If there is no arguments, git-indicator define 0xFF as default (all enabled).
- If your first arguments is greater than 0xFF, then 0xFF is set as default
- If there are many arguments, 0xFF is set as default
Examples
- I want all except OSD notifications:
$ ./bin/git-indicator 31 - I want test only main loop:
$ ./bin/git-indicator 1 - I want my git-indicator w/o main loop:
$ ./bin/git-indicator 62
We have some scripts which you may use (if needed). // to be continued
You might encounter some issues.
"Too many files opened" or "ulimit: max user processes: cannot modify limit"
It's all about linux file open descriptors. By default there are 2^10 per process which is pretty low actually. We have to increase it manually:
- Change the max hard limit from 2^10 to 2^16
sudo echo "* hard nofile 65536" >> /etc/security/limits.conf
The service script /usr/local/bin/git-indicator (which is used to launch the indicator) uses ulimit
command to increase the number of open descriptors automatically (to 2^16).
"This transport isn't implemented"
This error occurs (in most of the cases) when you want to access to repositories with SSH network protocol. Then you need to check if libssh2 library is correctly installed. If all is fine, you need to compile libgit2 sources with the right version (git-indicator source code compiled for 0.20.0) and try again.
- App-Indicator: API for panel indicator aera support (gnome).
- Libgit2: portable and pure C implementation of the Git core methods provided as a re-entrant linkable library with a solid API, allowing you to write native speed custom Git applications in any language which supports C bindings.
- NotifyOSD: desktop notifications framework providing a standard way of doing passive pop-up notifications on the Linux desktop.
- Libssh2: C library that implements the SSH2 protocol and provide a support transport for libgit2.
You can make pull requests adding the feature name
- Change GTK version from 2.x to 3.x
- Add repository information on click (and set local/remote branch comparison)
- Add
git pull origin <branch>action for each repository feature - Add more information into the OSD notification (last commit user etc.)
- Add no connection icon and disable percentage then
- Improve design for each repository status (markup for GTK)
- Change bitfield system by posix system (check this)
Currently, there is no pre-compiled package. I might be able to provide one, if somebody is interested. Just write a feature request.
This program is distributed under the terms of the MIT license. See LICENSE file.