GitInfo

PAGE.GitInfo

source.GitInfo

Page对象上的GitInfo方法返回带有附加方法的对象。

先决条件

安装 Git，创建一个存储库并提交项目文件。

您还必须允许Hugo访问您的存储库。在站点配置中：

enableGitInfo: true

enableGitInfo = true

{
   "enableGitInfo": true
}

或者在构建站点时使用命令行标志：

hugo --enableGitInfo

方法

AbbreviatedHash

(string) 缩写的提交哈希值。

{{ with .GitInfo }}
  {{ .AbbreviatedHash }} → aab9ec0b3
{{ end }}

AuthorDate

(time.Time) 作者日期。

{{ with .GitInfo }}
  {{ .AuthorDate.Format "2006-01-02" }} → 2023-10-09
{{ end }}

AuthorEmail

(string) 作者的电子邮件地址，符合 gitmailmap。

{{ with .GitInfo }}
  {{ .AuthorEmail }} → jsmith@example.org
{{ end }}

AuthorName

(string) 作者的名称，符合 gitmailmap。

{{ with .GitInfo }}
  {{ .AuthorName }} → John Smith
{{ end }}

Hash

(string) 提交的完整哈希值。

{{ with .GitInfo }}
  {{ .Hash }} → aab9ec0b31ebac916a1468c4c9c305f2bebf78d4
{{ end }}

Subject

(string) 提交的消息主题。

{{ with .GitInfo }}
  {{ .Subject }} → 添加教程
{{ end }}

最后修改日期

默认情况下，当enableGitInfo为true时，Page对象上的Lastmod方法返回文件的Git作者日期，该日期是最后一次提交包含该文件的日期。

您可以在您的站点配置中更改此行为。

托管考虑事项

在CI/CD环境中托管您的网站时，克隆项目存储库的步骤必须执行深度克隆。如果克隆是浅层的，则给定文件的Git信息可能不准确，它可能反映的是最近的存储库提交，而不是最后修改文件的提交。

一些提供商默认执行深度克隆，其他一些提供商允许您配置克隆深度，而某些提供商仅执行浅层克隆。