github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-14 20:37:55 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/docs/content/en/variables/git.md
Bjørn Erik Pedersen eb0ed33dfd
Merge commit '9aec42c5452b3eb224888c50ba1c3f3b68a447e9'
2023-09-24 11:54:45 +02:00

3.1 KiB
Raw Blame History

title linkTitle description categories keywords menu weight aliases
Git variables Git variables Get the last Git revision information for every content file.
variables and parameters
git
docs
parent weight
variables 70
70
/extras/gitinfo/

{{% 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

  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 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 ❌

  1. 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). ↩︎

  2. You can configure the GitHub Action to do a deep clone by specifying fetch-depth: 0 in the applicable "checkout" step of your workflow file, as shown in the Hugo documentation's example workflow file. ↩︎

  3. You can configure the GitLab Runner's clone depth as explained in the GitLab documentation; see also the Hugo documentation's example workflow file. ↩︎