For a recent project, we wanted to auto-generate our Git commit logs for inclusion in our final paper. Getting the pretty git log on the command line is easy:
git log --reverse --pretty --date=short
Converting this into the LaTeX friendly output we wanted, however, is not.
Yes, there are packages that remediate this problem, somewhat. latex-git-log is nice, but we didn’t want landscape pages, or all the excess info they include in their output. gitinfo2 is even more robust, but seemed a bit overcomplicated for our use case. If our commit log can be generated by a simple script, why can’t a TeX file with our commit log be generated by a simple script also?
Well, thanks to gitlog2latex, now it can!
Essentially, we escape LaTeX’s special characters using pandoc, then a few iterations of sed and awk to clean up the output and convert it into tables.
To use gitlog2latex, you want to grab it from github, move it into the directory you want to generate a log for, and run:
curl -O https://gist.githubusercontent.com/amritamaz/68d72c602a29635168ed/raw/4a2f064142b08f3c021e9a7562ec9116c0490cbf/gitlog2latex.sh chmod a+x gitlog2latex.sh mv [mydirectory] cd [mydirectory] ./gitlog2latex.sh
The file will be produced as
gitlog.tex. If you want to name it something else, change the
OUTPUT variable at the top of the script.