CTAN Comprehensive TeX Archive Network

Direc­tory macros/latex/contrib/gitver

README.md

Git Ver­sion (ver­sion 1.0)

URL: https://github.com/charles­bayn­ham/gitver (c) Charles Bayn­ham 2019

Li­cense: Project Public Li­cense 1.3c

This pack­age will get a de­scrip­tion of the cur­rent git ver­sion of this doc­u­ment and store it in a com­mand \gitVer. If mem­oir or fan­cy­hdr are in use, it will also add this to the doc­u­ment foot­ers un­less the op­tion "no­header" is passed.

It also de­fines a com­mand \versionBox{} which out­puts a box con­tain­ing the ver­sion and date of com­pi­la­tion

For this to work, you must have git in­stalled and avail­able on the com­mand line, this doc­u­ment must be part of a git repos­i­tory, and la­tex must be run­ning in "shell es­cape" mode. This can be en­abled by pass­ing --shell-escape on the com­mand line when com­pil­ing your docuemnt, or will be avail­able in the op­tions of what­ever GUI you're us­ing (try Googling).

Note that it's a good idea to tell git to ig­nore all the la­tex aux­i­lary files, oth­er­wise your ver­sion will al­ways be "dirty". Try the .gitignore file from git­ig­nore.io if you don't al­ready have one.

The pack­age is re­leased 'as is' with no war­ranty un­der the Project Public Li­cense, ver­sion 1.3c.

Down­load the con­tents of this pack­age in one zip archive (133.2k).

gitver – Get the cur­rent git hash of a project and type­set it in the doc­u­ment

This pack­age will get a de­scrip­tion of the cur­rent git ver­sion of the doc­u­ment and store it in a com­mand \gitVer. If mem­oir or fan­cy­hdr are in use, it will also add this to the doc­u­ment foot­ers un­less the op­tion “no­header” is passed.

The pack­age also de­fines a com­mand \ver­sionBox which out­puts a box con­tain­ing the ver­sion and date of com­pi­la­tion.

Pack­agegitver
Bug trackerhttps://github.com/charles­bayn­ham/gitver/is­sues
Re­pos­i­toryhttps://github.com/charles­bayn­ham/gitver
Ver­sion1.0 2019-02-06
Li­censesThe Project Public Li­cense 1.3c
Copy­right2019 Charles Bayn­ham
Main­tainerCharles Bayn­ham
Con­tained inTeX Live as gitver
TopicsVer­sion con­trol
Doc­u­ment Man­age­ment
...
Guest Book Sitemap Contact Contact Author