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.

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

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion src/commands/install-packages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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" }}
Copy link
Contributor Author

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.

paths:
- <<parameters.app-dir>>/.yarn/cache
- ~/.yarn/berry/cache # global cache, the default in Yarn Berry v4+
Copy link
Contributor Author

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.

- <<parameters.app-dir>>/.yarn/cache # project cache, the default in Yarn Berry > 2 and < 4
- when:
condition: << parameters.with-cache >>
steps:
Expand Down