mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
35dec7c96f
4dd2d6415 Fix erroridf example 9ae8e9199 Clarify highlight options f3943f9c8 Fix typo b57ea5ac8 Add field to glossary of terms 3191e35b4 Clarify comment in the new-in shortcode 870c8d35c Correct description of Ref and RelRef page methods c9df50e6e Specify encoding in description of crypto functions 749bb37e2 Add Ref, RelRef, and Site shortcode methods 994d4374b Update fmt functions 740f5ef96 Misc additions 77acdcdb6 Remove rssLimit from root config documentation df84a1795 Document the openapi3.Unmarshal function 24236f57d Miscellaneous edits and corrections 41b54d421 Hide the "new in" button after some period of time 3c1ebac31 Update Ancestors.md e699eb313 Add new-in tags to select functions and methods 5c41f0bf8 Clarify time.Format method f7bd43ae1 Add link to built-in render hook for GoAT diagrams 06f9cd4c9 Document the diagrams.Goat function 5e432e12d Adjust quick reference weights fc915efd6 Update FAQ 5bccf8b19 Use LinkTitle consistently in examples 36f207f3a Add page collection quick reference 699de883d Inlcude example of newScratch.Values 9bb7f8c78 Include RenderString example for emoji shortcodes 783fdd3ac Fix typo 26d5a4399 Fix typo c7e86f0cf Fix typo ad2a82fbd Clarify data type returned by partial and partialCached 1de5a52dd Miscellaneous corrections 3509e1b4d Update configuration-markup.md 8c6a9bf02 Clairfy figure shortcode output c9d0dc8fb Update Markdownify.md 0c4bc1447 Update theme 0f0ab2ade Add methods deprecated in v0.120.0 e1c6ecd0f Miscellaneous edits ec53b55b9 netlify: Hugo 0.120.4 23a1f3fd5 templates/internal.md: Correct GoogleAnalytics key name 6dcfa9a82 Update troubleshooting section 0c8857e8f Adjust code and code-toggle shortcodes 8820264d3 Reduce number of site audit warnings 526d06b90 Clarify hint option in image processing spec 310849daa Image Processing: Improve sentence and fix code sample 5bb67bfd4 Revert "Image Processing: Improve sentence and fix code sample" (#2318) 77c926fde Image Processing: Improve sentence and fix code sample 52179fb18 Miscellaneous edits f4e886715 Revert change to hugo.work c410fefa8 Update theme 8b72dfedd Rework where function documentation f35a7126f Minor edits to global page function 903b42ebc Cleanup shortcode calls c9247e98d Update documentation.md dff3c4abb Clean up build option descriptions and examples f46d31308 Use consistent signatures 2af2470b5 Minor correction to resources.GetRemote 45ec53fe0 Remove superfluous shortcode param 2a0544757 Improve deployment documentation 3cf36a7fc Clarify lang keyword f10d6495d Update front-matter.md dc94e20be Add Sveltia to CMS list b15d6d670 Update front-ends.md bb41588b2 Update FormatCurrency.md b40fff396 Add showcase for hidden sections without index.html 71316e181 Improve image filter examples d46f0b1d8 Miscellaneous edits ad3f9cdb6 Adjust quick reference guides 8657804ba Update theme d9e981147 Miscellaneous corrections 508666575 Miscellaneous updates 80b2241f9 Miscellaneous updates 723a827fd Namespace functions and methods 40212779a netlify: Hugo 0.120.3 66017c704 Bump GitHub workflows to latest versions db0f1e682 Update related.md 7e758c23b netlify: Hugo 0.120.2 641ba3976 Update configuration.md d2a9909d9 Update rss.md 7eb59d7a2 netlify: Hugo 0.120.1 708c351c4 Document debug.Timer 28e2388c2 Add new-in tag to images.Padding ee24cffb5 Add new-in tags to hugo.IsDevelopment and hugo.IsServer aa47ca023 netlify: Hugo 0.120.0 9c3e606fc docs: Regen docshelper 159fd971e commands/new: Remove format flag from new content cmd 9f7878092 Merge commit 'aaaf1c8df5d6aa061609d20510f7fa6c42e5cc1a' 65b2dd324 docs: Regenerate docshelper 2be620663 resources/images: Create padding image filter c777d6c5e Merge commit '3710a5ec7efe6baca6e452f43632c05d22bab3c4' 24f2afeb2 Merge commit 'e509cac533600cf4fa8382c9cdab78ddd82db688' 3f947c19a hugolib: Deprecate .Site.DisqusShortname 6bd1af892 hugolib: Deprecate .Site.GoogleAnalytics 78becc6ee tpl/tplimpl: Deprecate .Site.Social usage with internal templates e3ec2a4f2 common/hugo: Add hugo.IsServer and hugo.IsDevelopment git-subtree-dir: docs git-subtree-split: 4dd2d641531f74025ed9f51ea5a961e936988cfb
130 lines
3.9 KiB
Markdown
130 lines
3.9 KiB
Markdown
---
|
|
title: GitInfo
|
|
description: Returns Git information related to the last commit of the given page.
|
|
categories: []
|
|
keywords: []
|
|
action:
|
|
related:
|
|
- methods/page/CodeOwners
|
|
returnType: source.GitInfo
|
|
signatures: [PAGE.GitInfo]
|
|
toc: true
|
|
---
|
|
|
|
The `GitInfo` method on a `Page` object returns an object with additional methods.
|
|
|
|
{{% note %}}
|
|
Hugo's Git integration is performant, but may increase build times on large sites.
|
|
{{% /note %}}
|
|
|
|
## Prerequisites
|
|
|
|
Install [Git], create a repository, and commit your project files.
|
|
|
|
You must also allow Hugo to access your repository. In your site configuration:
|
|
|
|
{{< code-toggle file=hugo >}}
|
|
enableGitInfo = true
|
|
{{< /code-toggle >}}
|
|
|
|
Alternatively, use the command line flag when building your site:
|
|
|
|
```sh
|
|
hugo --enableGitInfo
|
|
```
|
|
|
|
{{% note %}}
|
|
When you set `enableGitInto` to `true`, or enable the feature with the command line flag, the last modification date for each content page will be the Author Date of the last commit for that file.
|
|
|
|
This is configurable. See [details].
|
|
|
|
[details]: /getting-started/configuration/#configure-dates
|
|
{{% /note %}}
|
|
|
|
## Methods
|
|
|
|
AbbreviatedHash
|
|
: (`string`) The abbreviated commit hash.
|
|
|
|
```go-html-template
|
|
{{ with .GitInfo }}
|
|
{{ .AbbreviatedHash }} → aab9ec0b3
|
|
{{ end }}
|
|
```
|
|
|
|
AuthorDate
|
|
: (`time.Time`) The author date.
|
|
|
|
```go-html-template
|
|
{{ with .GitInfo }}
|
|
{{ .AuthorDate.Format "2006-01-02" }} → 2023-10-09
|
|
{{ end }}
|
|
```
|
|
|
|
AuthorEmail
|
|
: (`string`) The author's email address, respecting [gitmailmap].
|
|
|
|
```go-html-template
|
|
{{ with .GitInfo }}
|
|
{{ .AuthorEmail }} → jsmith@example.org
|
|
{{ end }}
|
|
```
|
|
|
|
AuthorName
|
|
: (`string`) The author's name, respecting [gitmailmap].
|
|
|
|
```go-html-template
|
|
{{ with .GitInfo }}
|
|
{{ .AuthorName }} → John Smith
|
|
{{ end }}
|
|
```
|
|
|
|
Hash
|
|
: (`string`) The commit hash.
|
|
|
|
```go-html-template
|
|
{{ with .GitInfo }}
|
|
{{ .Hash }} → aab9ec0b31ebac916a1468c4c9c305f2bebf78d4
|
|
{{ end }}
|
|
```
|
|
|
|
Subject
|
|
: (`string`) The commit message subject.
|
|
|
|
```go-html-template
|
|
{{ with .GitInfo }}
|
|
{{ .Subject }} → Add tutorials
|
|
{{ end }}
|
|
```
|
|
|
|
## Last modified date
|
|
|
|
By default, when `enableGitInfo` is `true`, the `Lastmod` method on a `Page` object returns the Git AuthorDate of the last commit that included the file.
|
|
|
|
You can change this behavior in your [site configuration].
|
|
|
|
[git]: https://git-scm.com/book/en/v2/Getting-Started-Installing-Git
|
|
[gitmailmap]: https://git-scm.com/docs/gitmailmap
|
|
[site configuration]: /getting-started/configuration/#configure-front-matter
|
|
|
|
## Hosting considerations
|
|
|
|
When hosting your site in a CI/CD environment, the step that clones your project repository must perform a deep clone. If the clone is shallow, the Git information for a given file may not be accurate---it may reflect the most recent repository commit, not the commit that last modified the file.
|
|
|
|
Some providers perform deep clones by default, others allow you to configure the clone depth, and some providers only perform shallow clones.
|
|
|
|
Hosting service | Default clone depth | Configurable
|
|
:-- | :-- | :--
|
|
Cloudflare Pages | Shallow | Yes [^CFP]
|
|
DigitalOcean App Platform | Deep | N/A
|
|
GitHub Pages | Shallow | Yes [^GHP]
|
|
GitLab Pages | Shallow | Yes [^GLP]
|
|
Netlify | Deep | N/A
|
|
Render | Shallow | No
|
|
Vercel | Shallow | No
|
|
|
|
[^CFP]: 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`).
|
|
|
|
[^GHP]: 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](/hosting-and-deployment/hosting-on-github/#procedure).
|
|
|
|
[^GLP]: You can configure the GitLab Runner's clone depth [as explained in the GitLab documentation](https://docs.gitlab.com/ee/ci/large_repositories/#shallow-cloning); see also the Hugo documentation's [example workflow file](/hosting-and-deployment/hosting-on-gitlab/#configure-gitlab-cicd).
|