Files
hugo/content/en/variables/git.md
T
Patrick Kollitsch 963ddc994a docs: add a link to the mailmap documentation
I find that Hugo should contain more links to relevant documentation of features in other tools/documentations. Please let me know if we don't want that and I'll stop. In this specific case I read about `.mailmap` in the Hugo docs and as a developer knew what was meant, but I think less dev-y users might not understand this. Instead of starting to add paragraphs about the format maybe it's ok to link to the features docs? As I said, let me know if that is overkill/bloat. It would make my life easier than seeing a word and googling it :)

(for instance, if we link to git in this case we don't need to add extra-documentation about what the mailmap file should look like and what should be in there)
2021-12-26 17:05:52 +01:00

1.8 KiB

title, linktitle, description, date, publishdate, lastmod, categories, keywords, draft, menu, weight, sections_weight, aliases, toc, wip
title linktitle description date publishdate lastmod categories keywords draft menu weight sections_weight aliases toc wip
Git Info Variables Git Variables Get the last Git revision information for every content file. 2017-03-12 2017-03-12 2017-03-12
variables and params
git
false
docs
parent weight
variables 70
70 70
/extras/gitinfo/
false false

{{% note ".GitInfo Performance Considerations" %}} Hugo's Git integrations should be fairly performant but can increase your build time. This will depend on the size of your Git history. {{% /note %}}

.GitInfo Prerequisites

  1. The Hugo site must be in a Git-enabled directory.
  2. The Git executable must be installed and in your system PATH.
  3. The .GitInfo feature must be enabled in your Hugo project by passing --enableGitInfo flag on the command line or by setting enableGitInfo to true in your site's configuration file.

The .GitInfo Object

The GitInfo object contains the following fields:

.AbbreviatedHash
the abbreviated commit hash (e.g., 866cbcc)
.AuthorName
the author's name, respecting .mailmap
.AuthorEmail
the author's email address, respecting .mailmap
.AuthorDate
the author date
.Hash
the commit hash (e.g., 866cbccdab588b9908887ffd3b4f2667e94090c3)
.Subject
commit message subject (e.g., tpl: Add custom index function)

.Lastmod

If the .GitInfo feature is enabled, .Lastmod (on Page) is fetched from Git i.e. .GitInfo.AuthorDate. This behaviour can be changed by adding your own front matter configuration for dates.