Restore level property to avoid breaking change in patch version - #368
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
orestbida
approved these changes
Sep 3, 2022
orestbida
left a comment
orestbida
left a comment
Owner
There was a problem hiding this comment.
Yes, this change was unintentional (see #349 (comment)).
Restoring the level field is certainly a good idea! Thanks a lot for your contrib.!
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
In this commit: Rename level property to categories (breaking change), the breaking change was introduced (as a response to this issue: Inconsistent naming - category vs. level). Although the change alone is ok, according to the SemVer, since it is a breaking change, such change should be included only in a major update e.g. v3.0.0.
For the patch update such as v2.8.0 -> v2.8.1, there shouldn't be any incompatible API changes. I came across this issue when I updated my packages using
npm update(update v2.8.0 to v2.8.5 broke the plugin for me, because I was usinglevelproperty from v2.8.0).I think it's a good idea to keep
levelproperty until v.3.0.0. What do you think?