Skip to content

Always hide cache-dir contents from Git#8798

Merged
jekyllbot merged 2 commits intojekyll:masterfrom
ashmaroli:gitignore-cache-dir
Sep 16, 2021
Merged

Always hide cache-dir contents from Git#8798
jekyllbot merged 2 commits intojekyll:masterfrom
ashmaroli:gitignore-cache-dir

Conversation

@ashmaroli
Copy link
Copy Markdown
Member

  • This is a 🙋 feature or enhancement.
  • I've added tests
  • The test suite passes locally

Summary

Cache-dir and its contents shouldn't be tracked by version control even if users do not add the directory to their .gitignore file.

Context

Currently, while jekyll new generates a new site with .jekyll-cache added to the .gitignore, existing sites using Jekyll 3 on migrating to Jekyll 4 will have to manually update their .gitignore file as well.
Similarly, users on Jekyll 4 but opting to use a custom cache-dir location will also have to manually update their .gitignore file.

Additionally, Jekyll contributors switching between master (or any recent branch) and 3.9-stable (and older) will also have to manually handle cache dir contents because the .gitignore files in older checkouts do not ignore .jekyll-cache.

This pull request resolves the above UX hiccups.

@ashmaroli ashmaroli requested review from DirtyF and mattr- September 1, 2021 07:06
@jekyll jekyll deleted a comment from lizzby Sep 1, 2021
Copy link
Copy Markdown
Member

@mattr- mattr- left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this solution.

:shipit:

@ashmaroli
Copy link
Copy Markdown
Member Author

@jekyllbot: merge +minor

@jekyllbot jekyllbot merged commit 891a786 into jekyll:master Sep 16, 2021
jekyllbot added a commit that referenced this pull request Sep 16, 2021
github-actions bot pushed a commit that referenced this pull request Sep 16, 2021
Ashwin Maroli: Always hide cache-dir contents from Git (#8798)

Merge pull request 8798
@jekyll jekyll locked and limited conversation to collaborators Sep 16, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants