An ideal solution would be to include git describe --dirty as a footer on every page.
For a "release" revision which has a pretty tag like v0.1.0, it would display just that. If it is rendering a non-tagged commit, git describe --dirty would display a commit id suffix, like v0.1.0-a0b1c2d4.
If there are uncommitted changes, I believe it would also append * (or have some other indicator).
This would make it entirely unambiguous which git revision is rendered.
What is the problem?
When viewing the rendered output at https://electric-coin-company.github.io/tfl-book/ it's not possible to tell which version is rendered.
Do you recommend a solution?
An ideal solution would be to include
git describe --dirtyas a footer on every page.For a "release" revision which has a pretty tag like
v0.1.0, it would display just that. If it is rendering a non-tagged commit,git describe --dirtywould display a commit id suffix, likev0.1.0-a0b1c2d4.If there are uncommitted changes, I believe it would also append
*(or have some other indicator).This would make it entirely unambiguous which git revision is rendered.