Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Rename CACHE_DIRECTORY to .erb_lint_cache. #380

Merged
merged 1 commit into from
Sep 24, 2024
Merged

Rename CACHE_DIRECTORY to .erb_lint_cache. #380

merged 1 commit into from
Sep 24, 2024

Conversation

joshuapinter
Copy link
Contributor

From .erb-lint-cache.

This is to align with the general renaming and standardization from erb-lint and erblint to erb_lint.

Fixes #379.

@joshuapinter
Rename CACHE_DIRECTORY to .erb_lint_cache.
af5f18e 
From `.erb-lint-cache`.

This is to align with the general renaming and standardization from `erb-lint` and `erblint` to `erb_lint`.

Fixes Shopify#379.
@joshuapinter joshuapinter mentioned this pull request Sep 24, 2024
Closed
etiennebarrie
etiennebarrie approved these changes Sep 24, 2024
View reviewed changes
Copy link
Member

@etiennebarrie etiennebarrie left a comment

Choose a reason for hiding this comment

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

Do you think we need to do anything about the migration or just document this in the release notes when releasing the new version?

@joshuapinter
Copy link
Contributor Author

Good question. Personally, I just rolled this into our app and it just had to rebuild the cache fresh the first time and I just had to update the .gitignore and some other references to it.

I wouldn't consider this a breaking change or anything. Since we're not at v1 yet I think it's fair just to put it into the Release Notes / CHANGELOG.md, which I forgot to do btw.

Let me know what you think and I can update the PR.

@etiennebarrie
Copy link
Member

I wouldn't consider this a breaking change or anything. Since we're not at v1 yet I think it's fair just to put it into the Release Notes / CHANGELOG.md, which I forgot to do btw.

Yeah I think it's good enough to have a good message. We don't have a changelog file but we use GitHub releases which show up in Dependabot PRs for example.

Thanks for your contribution!

@etiennebarrie etiennebarrie merged commit 5c63068 into Shopify:main Sep 24, 2024
6 checks passed
@joshuapinter
Copy link
Contributor Author

👍 Awesome, thanks for the quick turnaround.

Btw, I have another PR (#300) that is critical for anybody using the cache, which breaks it when there are configuration or Gemfile changes to avoid false negatives, etc. If there's anything you can do to give it some attention, it would be valuable. We're using it in Production in our fork and it's been solid for us.

Thanks again.

@joshuapinter joshuapinter deleted the rename_cache_directory branch September 24, 2024 14:25
@etiennebarrie
Copy link
Member

Yes, I saw. I liked #373 quite a bit better, we just need some specs.

@joshuapinter
Copy link
Contributor Author

Yep, I agree. That's much more clever. :) Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@etiennebarrie etiennebarrie etiennebarrie approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Rename CACHE_DIRECTORY from .erb-lint-cache to .erb_lint_cache?
2 participants
@joshuapinter @etiennebarrie