-
Notifications
You must be signed in to change notification settings - Fork 81
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.
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
feat: support Yarn Berry global cache #201
feat: support Yarn Berry global cache #201
Conversation
@@ -176,7 +176,8 @@ steps: | |||
- save_cache: | |||
key: node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>><<^parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-package.json" }}-<</parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-lockfile" }} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When updating versions of yarn
, it writes the packageManager
key to package.json
. So, when updating between Yarn 3 and 4, it should trigger a cache invalidation based on this existing key.
There is a corner-case where someone updated to Yarn 4 with an older version of this orb where they wouldn't get the global cache. However, it didn't feel important enough to update this key to invalidate all Yarn Berry caches with this change.
@@ -176,7 +176,8 @@ steps: | |||
- save_cache: | |||
key: node-deps-{{ arch }}-<<parameters.cache-version>>-<<#parameters.include-branch-in-cache-key>>{{ .Branch }}-<</parameters.include-branch-in-cache-key>><<^parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-package.json" }}-<</parameters.cache-only-lockfile>>{{ checksum "/tmp/node-project-lockfile" }} | |||
paths: | |||
- <<parameters.app-dir>>/.yarn/cache | |||
- ~/.yarn/berry/cache # global cache, the default in Yarn Berry v4+ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI, the documentation on this is incorrect right now: https://yarnpkg.com/configuration/yarnrc#globalFolder. See yarnpkg/berry#6003 for a PR to update the docs to be correct.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for your contribution and all the extra context provided in PR! It's very much appreciated 🙏
In Yarn Berry v4+, the default is to cache dependencies into a global cache (
~/.yarn/berry/cache
), as you can see here:To make this work transparently for all Yarn Berry users, we should cache both the global and project-level caches.