GitInfo

January 1, 1

GitInfo 方法在 Page 物件上返回一個具有額外方法的物件。

前置條件

安裝 Git，創建一個倉庫並提交項目文件。

你還必須允許 Hugo 訪問你的倉庫。在你的網站配置中：

hugo.

enableGitInfo: true

enableGitInfo = true

{
   "enableGitInfo": true
}

或者，使用命令行參數在構建你的網站時啟用它：

hugo --enableGitInfo

(string) 簡短的提交哈希。

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

(time.Time) 作者日期。

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

(string) 作者的電子郵件地址，遵循 gitmailmap。

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

(string) 作者的名字，遵循 gitmailmap。

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

(time.Time) 提交日期。

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

(string) 提交哈希。

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

(string) 提交信息主題。

{{ with .GitInfo }}
  {{ .Subject }} → Add tutorials
{{ end }}

(string) 提交信息正文。

{{ with .GitInfo }}
  {{ .Body }} → - Two new pages added.
{{ end }}

默認情況下，當 enableGitInfo 設置為 true 時，Page 物件上的 Lastmod 方法返回的是包含該文件的最後提交的 Git AuthorDate。

你可以在網站配置中更改此行為。

當你在 CI/CD 環境中託管你的網站時，用於克隆項目倉庫的步驟必須進行深度克隆。如果克隆為淺克隆，則給定文件的 Git 資訊可能不準確——它可能反映的是最近的倉庫提交，而不是最後修改該文件的提交。

一些提供商默認進行深度克隆，其他提供商允許你配置克隆深度，還有一些提供商僅執行淺克隆。

要為 Cloudflare Pages 站點配置深度克隆，將站點的常規 Hugo 構建命令前置為 git fetch --unshallow &&（例如，git fetch --unshallow && hugo）。 ↩︎
你可以通過在工作流文件的 “checkout” 步驟中指定 fetch-depth: 0 來配置 GitHub 操作進行深度克隆，如 Hugo 文檔中的範例工作流文件所示。 ↩︎
你可以根據 GitLab 文檔中所述配置 GitLab Runner 的克隆深度；另見 Hugo 文檔中的範例工作流文件。 ↩︎