https://github.com/saneef/eleventy-plugin-git-commit-date

Eleventy plugin to get recent Git commit time of a file, or a Eleventy collection.
https://github.com/saneef/eleventy-plugin-git-commit-date

11ty 11ty-plugin date eleventy eleventy-plugin git git-commit

Last synced: 17 days ago
JSON representation

Eleventy plugin to get recent Git commit time of a file, or a Eleventy collection.

• Host: GitHub
• URL: https://github.com/saneef/eleventy-plugin-git-commit-date
• Owner: saneef
• License: mit
• Created: 2021-08-19T09:06:25.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-06-26T07:56:54.000Z (over 1 year ago)
• Last Synced: 2024-10-19T15:03:14.320Z (20 days ago)
• Topics: 11ty, 11ty-plugin, date, eleventy, eleventy-plugin, git, git-commit
• Language: JavaScript
• Homepage:
• Size: 36.1 KB
• Stars: 11
• Watchers: 3
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# eleventy-plugin-git-commit-date

This Eleventy plugin provides two [template filters](https://www.11ty.dev/docs/filters/):

| Filter                             | Description                                                                                                                                   |

| :--------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------- |

| `getGitCommitDateFromPath`         | Gets Git commit date from path.

Usage: `{{ page.inputPath \| getGitCommitDateFromPath }}`                                              |

| `getCollectionNewestGitCommitDate` | Get Git commit date of the newest committed file from a collection.

Usage: `{{ collections.all \| getCollectionNewestGitCommitDate }}` |

🌏 This plugin is made primarily to populate `` fields in an RSS feed. Here is [a blog post on how to use this plugin](https://saneef.com/tutorials/fix-dates-on-eleventy-rss-feeds/) with [`eleventy-plugin-rss`](https://www.11ty.dev/docs/plugins/rss/).

⚠️ Getting Git commit date is a bit slow (\~50ms for each path). So, use it sparingly. It's recommended to call this filter within a production flag.

## Usage

### 1. Install

```sh

npm install eleventy-plugin-git-commit-date

```

### 2. Add to Eleventy config

```js

// .eleventy.js

const pluginGitCommitDate = require("eleventy-plugin-git-commit-date");

module.exports = function (eleventyConfig) {

  eleventyConfig.addPlugin(pluginGitCommitDate);

};

```

### 3. Use in templates

```nunjucks

Using {{ page.inputPath | getGitCommitDateFromPath }} will display the git commit date of the file using a local time zone like:

Sun Dec 31 2017 18:00:00 GMT-0600 (Central Standard Time)

Using {{ collections.all | getCollectionNewestGitCommitDate }} will display the git commit date of newest file in the collection using a local time zone like:

Sun Dec 31 2017 18:00:00 GMT-0600 (Central Standard Time)

```

## FAQs

### When used with GitHub Pages, why are the last commit dates incorrect?

Only the last commit is checked out by [GitHub Action Checkout](https://github.com/actions/checkout#:~:text=Only%20a%20single%20commit%20is%20fetched%20by%20default) by default. The commit dates for files changed in the previous commits will not be available. You can set the `fetch-depth` as `0` to get all the history from the Git repository.

```diff

   - name: Checkout

     uses: actions/checkout@v3

+    with:

+      fetch-depth: 0

```

## Credits

- [@zachleat](https://github.com/11ty/eleventy/issues/142) suggested the use of Git commit dates instead of modified date.

- The code is based on [@vuepress/plugin-last-updated](https://github.com/vuejs/vuepress/tree/master/packages/@vuepress/plugin-last-updated).