Gource is Git shiny.
Gource is an open source GPLv3 licensed OpenGL visualiser of Git/SVN/Mecurial, and Bazaar repositories over time and so serves well to indicate a project’s growth / activity.
Wikipedia’s “A picture is worth a thousand words” page has the following:
“The actual Chinese expression “Hearing something a hundred times isn’t better than seeing it once” (百闻不如一见, p bǎi wén bù rú yī jiàn) is sometimes introduced as an equivalent, as Watts‘s “One showing is worth a hundred sayings”. This was published as early as 1966 discussing persuasion and selling in a book on engineering design.”
Rockstor’s 5 git repositories visualised in just over 1.5 minutes.
The essence of Gource’s use, at least on a linux desktop, is to initially build from the code and then point the resulting binary at a copy of one’s repository. The wrinkle here is that Rockstor, akin to many projects, consists of multiple repositories:
- rockstor-doc – our docs in their original restructured text format.
- rockstor-core – the main code repository.
- rockon-registry – our docker based ‘rock-on’ plugins repo.
- rockstor-iso – code / artifacts concerning the creation of our stable release iso images.
- rockstor-jslibs – the collection of js libraries we use to do what js does best.
But fear not as the now 29 strong developers of Gource have us covered in their appropriately named: Visualizing-Multiple-Repositories.
“Sometimes it may be interesting to show the history of multiple projects in the same Gource animation.”
This mini HowTo is essentially a re-telling of that page as applied to Rockstor’s 5 repositories. The hope is that this ‘telling’ might aid other multi-repo projects and save us all some time; at least on mass.
As of 8th September 2017 v0.47 was released which is the version I used here. Be sure to visit their releases page to check on availability of any newer releases. As always it’s best to resource the original text on install matters: please favour the projects own INSTALL doc over what I state here. But by way of completeness I’ll indicate how it worked for me:
Using a Fedora26 desktop:
sudo dnf install git freetype-devel pcre-devel glew-devel SDL2-devel SDL2_image-devel boost-filesystem boost-devel glm-devel
tar xvf gource-0.47.tar.gz
We refrain from ‘make install’ to keep all our gource activities confined to our Downloads dir. (snap / flatpak suggestions anyone?)
Now we jump up a directory and grab a local copy of Rockstor’s repos:
git clone https://github.com/rockstor/rockstor-core.git
git clone https://github.com/rockstor/rockstor-doc.git
git clone https://github.com/rockstor/rockon-registry.git
git clone https://github.com/rockstor/rockstor-jslibs.git
git clone https://github.com/rockstor/rockstor-iso.git
then we resource Gource’s ability to create a custom-log of activity spanning all the above repos. For this we jump back into our gource build directory:
and point the binary at each of the rockstor repos in turn with switches requesting our needed custom logs.
./gource --output-custom-log ../doc-log.txt ../rockstor-doc/
./gource --output-custom-log ../core-log.txt ../rockstor-core/
./gource --output-custom-log ../rockon-log.txt ../rockon-registry/
./gource --output-custom-log ../iso-log.txt ../rockstor-iso/
./gource --output-custom-log ../jslibs-log.txt ../rockstor-jslibs/
Then back up to our new logs:
Next we make our repos more distinct by putting them on separate branches via multiple stream edits (sed):
sed -i -r "s#(.+)\|#\1|/doc-repo#" doc-log.txt
sed -i -r "s#(.+)\|#\1|/core-repo#" core-log.txt
sed -i -r "s#(.+)\|#\1|/rockon-repo#" rockon-log.txt
sed -i -r "s#(.+)\|#\1|/iso-repo#" iso-log.txt
sed -i -r "s#(.+)\|#\1|/jslibs-repo#" jslibs-log.txt
Now we combine our custom activity logs in a single “all-rockstor-repos-log.txt” thus:
cat doc-log.txt core-log.txt rockon-log.txt iso-log.txt jslibs-log.txt | sort -n > all-rockstor-repos-log.txt
And finally, at least for now, we can move back to our binary dir:
Gource Plays Rockstor Repos
Rockstor dev at 20 days a second = 1m 37s:
(Less than fair as major contributions / contributors flash by but serves as a quick test run.)
./gource -1280x720 --seconds-per-day 0.05 --highlight-users --highlight-colour E76545 --hide filenames --hide-root --multi-sampling ../all-rockstor-repos-log.txt
And if you liked that, try the slightly more sane speed variant of:
Rockstor dev at 5 days a second = 5m 43s:
./gource -1280x720 --seconds-per-day 0.2 --highlight-users --highlight-colour E76545 --hide filenames --hide-root --multi-sampling ../all-rockstor-repos-log.txt
Note the following abstract of the interactive controls:
- (TAB) key to switch user highlight
- (Space bar) pause / resume the animation
- (V) center camera on above user (if selected) – bit much on the brain
- (F12) Screenshot
- (Alt+Enter) Fullscreen toggle – a winner this one
- (+-) Adjust simulation speed
- (ESC) Quit
There’s also a nice selection of mouse interactions such as jumping to any time point; although this does reset the graph. While paused one can inspect the details of individual files and users, and dragging with the left mouse button manually controls the camera. Centre button toggles tracking / entire tree view.
Building the Bling Vid
To capture the raw video we use Gource’s “-o” switch.
Entire dev history in 1.5m (earlier video):
./gource -1280x720 --seconds-per-day 0.05 --highlight-users --highlight-colour E76545 --hide filenames --hide-root --multi-sampling ../all-rockstor-repos-log.txt -o ../rockstor-dev.ppm
sudo dnf install ffmpeg
ffmpeg -y -r 60 -f image2pipe -vcodec ppm -i ../rockstor-dev.ppm -vcodec libx264 -preset medium -pix_fmt yuv420p -crf 20 -threads 0 -bf 0 ../rockstor-dev.mkv
And 16.2 GB becomes 33 MB.
Entire dev history in just under 6 minutes (slightly less manic):
./gource -1280x720 --seconds-per-day 0.2 --highlight-users --highlight-colour E76545 --hide filenames --hide-root --multi-sampling ../all-rockstor-repos-log.txt -o ../rockstor-dev-long.ppm
ffmpeg -y -r 60 -f image2pipe -vcodec ppm -i ../rockstor-dev-long.ppm -vcodec libx264 -preset medium -pix_fmt yuv420p -crf 20 -threads 0 -bf 0 ../rockstor-dev-long.mkv
57 GB via a similar ffmpeg command (differing file names) becomes 60 MB: bargain.
And finally the last 90 days at the rather more sedate 1 second/day = 1m 31s:
./gource -1280x720 --seconds-per-day 1 --start-date $(date -I --date='-90 days') --highlight-users --highlight-colour E76545 --hide filenames --hide-root --multi-sampling ../all-rockstor-repos-log.txt -o ../rockstor-dev-last-90days.ppm
ffmpeg -y -r 60 -f image2pipe -vcodec ppm -i ../rockstor-dev-last-90days.ppm -vcodec libx264 -preset medium -pix_fmt yuv420p -crf 20 -threads 0 -bf 0 ../rockstor-dev-last-90days.mkv
Where 15 GB via ffmpeg becomes 9 MB.
Note that as with the mouse ‘time jumps’ in the interactive mode covered earlier, using the “–start-date” option, as we have just done, results in no previous activity being displayed. That is, only files changed after the given date, and their respective repositories, will appear in the resulting Gource graph.
And thus we have our thousand words.