e509cac533
cb18a5183 Fix broken link 07a0198bf Config: Place Google Analytics tag ID under the services key 4bf0c719f Fix typo 50d8ad1af Fix muiltilingual menu definition instructions 1a32519a9 Fix typos 6f34ca8e0 Explain usage of front matter to target a template 5bd977257 Improve goldmark config docs 447632938 Remove Docker notes from installation instructions 84741d173 Update reference to hugo.work 0338d7c71 Fix menu template f5d2f5ed4 Fix typos in content/en/functions/fmt a3a40ff99 Add return type to functions 85ac3e779 Remove outdated feature image d47d889e4 Fix signatures 7551ba28f Document safe.JSStr function e77993be0 Document keyVals function 4dba20db3 Update theme babf91544 Update echoparam 8c8203efa Adjust related functions 4cb1b30fc Fix example ba95eca64 Improve showcase prose 5d3dcf366 Add Overmind Studios showcase 8d634ac70 Change code blocks from indented to fenced cfab978e6 Add missing code fences 407dd5c47 Limit related pages for functions to other functions 9fa67d981 Fix .Site.LastChange doc 393aa16d0 netlify: Hugo 0.119.0 f864af97a docs: Even more about images.Process 9d772d5f0 docs: More about images.Process bc655f869 docs: Regen docshelper 41c3536d1 Merge commit '9aec42c5452b3eb224888c50ba1c3f3b68a447e9' 918ed53f4 Add images.Process filter 573645883 Add $image.Process a1151b0fd Add images.Opacity filter git-subtree-dir: docs git-subtree-split: cb18a5183fc62f301ffde50b8c39f03e4b897aec
3.1 KiB
| title | linkTitle | description | categories | keywords | menu | weight | aliases | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Git variables | Git variables | Get the last Git revision information for every content file. |
|
|
|
70 |
|
{{% note %}} 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
- The Hugo site must be in a Git-enabled directory.
- The Git executable must be installed and in your system
PATH. - The
.GitInfofeature must be enabled in your Hugo project by passing--enableGitInfoflag on the command line or by settingenableGitInfototruein 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 behavior can be changed by adding your own front matter configuration for dates.
Hosting considerations
On the site host, your repository must be "deep-cloned," so the returned .GitInfo data will be accurate. Otherwise, your site may display only data from your latest commit. Where it's not possible to configure a host's cloning depth, you must handle this through CI/CD (e.g., a GitHub Action or GitLab CI/CD). See the following table:
| Hosting service | Clone depth | Configurable? |
|---|---|---|
| Cloudflare Pages | Shallow | ✔️ 1 |
| DigitalOcean App Platform | Deep | ❌ |
| GitHub Pages | Shallow | ✔️ 2 |
| GitLab Pages | Shallow | ✔️ 3 |
| Netlify | Deep | ❌ |
| Render | Shallow | ❌ |
| Vercel | Shallow | ❌ |
-
To configure a Cloudflare Pages site for deep cloning, preface the site's normal Hugo build command with
git fetch --unshallow &&(e.g.,git fetch --unshallow && hugo). ↩︎ -
You can configure the GitHub Action to do a deep clone by specifying
fetch-depth: 0in the applicable "checkout" step of your workflow file, as shown in the Hugo documentation's example workflow file. ↩︎ -
You can configure the GitLab Runner's clone depth as explained in the GitLab documentation; see also the Hugo documentation's example workflow file. ↩︎