Use last commit as a date front matter option

[zachleat]

This will alleviate the problem of deploying on a remote server and losing all of your file creation/updated dates and also make it unnecessary to hard code dates.

Inspired by vuepress https://vuepress.vuejs.org/default-theme-config/#last-updated

[zachleat]

This repository is now using lodash style issue management for enhancements. This means enhancement issues will now be closed instead of leaving them open.

The enhancement backlog can be found here: https://github.com/11ty/eleventy/issues?utf8=%E2%9C%93&q=label%3Aneeds-votes+sort%3Areactions-%2B1-desc+

[zachleat]

Related:

• https://www.npmjs.com/package/git-raw-commits
• https://www.npmjs.com/package/git-log-parser
• https://stackoverflow.com/questions/4784575/how-do-i-find-the-most-recent-git-commit-that-modified-a-file#4784629

https://github.com/11ty/eleventy/blob/master/src/Template.js#L615

Maybe worth creating a new abstraction for template dates?

[ghost]

I just wanted to point out that the discussion is mostly about the last commit date so far. There are considerations around first commit date as well, such as if this should operate as if the follow option was specified or not. This would have implications if a file was renamed. The correct behaviour is non-obvious as it would likely need to be dealt with on a case-by-case basis.

Should there be a new config section to specify some of these options? or should it be specified in the front matter of each page?

[adamduncan]

We currently have Last Modified, which is super handy when building locally. Although have noticed it retruns a possibly misleading value in CI environments.

Would it be helpful to include Last Changed as an additional value available for use with Content dates?

I expect it might break the existing understanding of Last Modified (using ctime under the hood) vs. mtime 🤔

Or will we still need some git log wizardry to get a file's true Last modified (committed) date?

[ghost]

I've been playing with some ideas and so far the most promising is by using git-date-extractor in a prebuild script that drops the created and modified dates into a global datafile. The problem is that the build times do take quite a long time, even after filtering to only files in the sitemap. 24 files takes about 40-ish seconds to crawl and generate in the repo.

May have to look into caching results and truncating the search to recent commits.

[Ryuno-Ki]

Thanks, @BrentARitchie.
I looked into the source code. I think, it can be simplified of our use case.
Basically, applying How to retrieve the last modification date of all files in a git repository with git log RETTY FORMATS yields:

git ls-tree -r --name-only HEAD | while read filename; do echo "$(git log -n1 --format=%aI $filename) $filename"; done

In case you can't read bash:

• git ls-tree: List the contents of a tree object
• -r: Do so recursively
• --name-only: Only output the path
• HEAD: The latest commit (on main/master)

This yields a list of file names git knows about.
You pipe this into a while loop in bash, where the item is assigned to a variable filename in each iteration.

• git log: Show information
• n1 (or -1): Limit to top one (the latest)
• --format=%aI: Use strict ISO format (see the docs)
• $filename: Apply to the current file path

I'd suggest to replace the git ls-tree and while loop in Node to increase the cross-platform compatibility.
Then, trigger a exec form child_process for each file (or use the git ls-tree to compile the list to be sure?).

[zachleat]

This adds a date: "git Last Modified" option to populate page.date with the last git commit.

Importantly, if a file is not checked into git, returns Date.now() instead.

See https://github.com/11ty/eleventy/blob/8f35e553f80a9a75da3b2eb1a923ecce87f65573/src/Util/DateGitLastUpdated.js and thanks to VuePress for the implementation!

This is a little bit expensive so maybe use sparingly (or only in production?). Will pair nicely with ENV variables and directory data files:

e.g. _posts/_posts.11tydata.js

if(process.env.CONTEXT === "production") {
  module.exports = {
    date: "git Last Modified"
  };
}

module.exports = {};

This is slated to ship with 1.0.1

[nhoizey]

On a project, I would need a "git First Commited", do you think it would possible to add it with a similar command?

Here's how I currently get it in a Bash script:

fileDate=$(git log --all --diff-filter=A --pretty=%x0a%ci --name-only | awk '
/^$/        { dateline=!dateline; next }
dateline    { date=$0; next }
!seen[$0]++ { print date,$0 }
' | grep "$fileBasename" | head -1)

Found it in https://stackoverflow.com/a/32894198/717195

[zachleat]

@nhoizey can you file this as a separate issue? I’d be open to adding an config point for folks to add their own callbacks too

[nhoizey]

Done: #2224

[kkga]

Has anyone tried this with Vercel?
It creates a shallow clone of the git repo with only latest 10 timestamps of git history (using --depth 10, source), so the timestamp returned by git log would not actually represent the last commit date for given file in most cases.

[zachleat]

Good callout @kkga, probably worth adding a warning to the docs!