Sets the default compression to 0 #5526
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
merceyz
requested changes
Jun 24, 2023
This was referenced Oct 24, 2023
arcanis
added a commit
that referenced
this pull request
Oct 24, 2023
**What's the problem this PR addresses?** Closes: #5843 Refs: #5526 **How did you fix it?** Updated the default compressionLevel to '0' in documentation. **Checklist** <!--- Don't worry if you miss something, chores are automatically tested. --> <!--- This checklist exists to help you remember doing the chores when you submit a PR. --> <!--- Put an `x` in all the boxes that apply. --> - [x] I have read the [Contributing Guide](https://yarnpkg.com/advanced/contributing). <!-- See https://yarnpkg.com/advanced/contributing#preparing-your-pr-to-be-released for more details. --> <!-- Check with `yarn version check` and fix with `yarn version check -i` --> - [x] I have set the packages that need to be released for my changes to be effective. <!-- The "Testing chores" workflow validates that your PR follows our guidelines. --> <!-- If it doesn't pass, click on it to see details as to what your PR might be missing. --> - [x] I will check that all automated PR checks pass before the PR gets reviewed. --------- Co-authored-by: Maël Nison <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What's the problem this PR addresses?
Cache compression doesn't seem the best option nowadays:
Its main advantage is for some amazingly large packages, where storing them inside a Git repository would be impossible (GitHub has a 600MB file limit). But since we changed the cache default to
enableGlobalCache: true, this isn't relevant by default, so the cache compression should be set to zero.One potential issue is how it may give the impression that Yarn became worse for global cache users. We don't believe it's the case (Git can delta uncompressed archives in some measure, making it less expensive to upgrade from one package version to another), but to the average eye it may not look as such.
How did you fix it?
This diff sets the new default compression setting to 0.
To avoid breaking projects' (or at least not making the migration more difficult), I added a rule to automatically set
compressionLevel(andenableGlobalCache) to their 3.x default values when runningyarn installin a 3.x project. When users are ready they can remove these settings and re-run the install.I kept the current compression level on our repository to avoid changing all archives again. I think we'll have to think of purging the repository in some form to migrate it to
compressionLevel: 0.Checklist