blogs/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2026-08-24 15:28:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add warning on GitInfo and Shallow Clones

Browse Source
This commit is contained in:
nickg
2017-05-21 19:06:15 -07:00
committed by digitalcraftsman
parent fa5be591f5
commit f3c88b0810
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
content/extras/gitinfo.md
+5 -1
View File
@@ -44,7 +44,11 @@ Subject
: commit message subject, e.g. `tpl: Add custom index function`
## Performance Considerations
## Other Considerations
The Git integrations should be fairly performant, but it does add some time to the build, which depends somewhat on the Git history size.
The accuracy of data depends on the underlying local git respository. If the local repository is a *shallow clone*, then any file that hasn't been modified in the truncated history will default to data in the oldest commit. In particular, if the respository has been cloned using `--depth=1` then every file will the exact same `GitInfo` data -- that of the only commit in the repository.
In particular, many CI/CD systems such as [travis-ci.org](https://travis-ci.org) default to a clone depth of 50 which is unlikely to be deep enough. You can explicitly add back the missing history using using `git fetch --unshallow` or [make the initial checkout deeper](https://docs.travis-ci.com/user/customizing-the-build#Git-Clone-Depth).