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: enable overlay by default #3108

Merged
merged 1 commit into from Mar 25, 2021
Merged

feat: enable overlay by default #3108

merged 1 commit into from Mar 25, 2021

Conversation

snitin315
Copy link
Member

  • This is a bugfix
  • This is a feature
  • This is a code refactor
  • This is a test update
  • This is a docs update
  • This is a metadata update

For Bugs and Features; did you add new tests?

Yes

Motivation / Use-Case

Fixes #3103

Breaking Changes

Additional Info

Co-authored-by: Rishabh Chawla <rishabh31121999@gmail.com>
@codecov
Copy link

codecov bot commented Mar 25, 2021

Codecov Report

Merging #3108 (bfc6da2) into master (45b698d) will increase coverage by 0.09%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #3108      +/-   ##
==========================================
+ Coverage   91.84%   91.93%   +0.09%     
==========================================
  Files          37       37              
  Lines        1288     1290       +2     
  Branches      346      347       +1     
==========================================
+ Hits         1183     1186       +3     
+ Misses         99       98       -1     
  Partials        6        6              
Impacted Files Coverage Δ
lib/utils/normalizeOptions.js 100.00% <100.00%> (ø)
lib/Server.js 93.50% <0.00%> (+0.20%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 45b698d...bfc6da2. Read the comment docs.

@snitin315 snitin315 merged commit 5e05e48 into master Mar 25, 2021
@snitin315 snitin315 deleted the overlay branch March 25, 2021 18:39
@jordanbtucker
Copy link

Can this be promoted to BREAKING CHANGE?

This will require users to change their existing configuration to continue using the package in the same way they were using it before (without an overlay if not specified), therefore it's a BREAKING CHANGE.

Although in isolation, this shouldn't really cause any issues. If someone upgrades from v3 to v4, at best it could confuse them if they didn't have this turned on in v3. At worst, this could cause conflicts with third-party overlays in existing projects when they upgrade to v4, essentially breaking the development process. So just because a v3 config works with v4, it doesn't mean that this feature doesn't have repercussions when you change a default.

If this isn't specifically called out as a BREAKING CHANGE in the release notes, then it can be missed by developers upgrading from v3 to v4 and take a while to track down the cause (increasing the number of issues opened on this repo).

@alexander-akait
Copy link
Member

@jordanbtucker Yep, we just missing this in changelog, anyway we will provide full list of breaking changes and other notes for all options for stable v4 release, so you will do upgrade easy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants