search

shadowwalker / next-pwa

Zero config PWA plugin for Next.js, with workbox 🧰
MIT License
3.86k stars 323 forks source link

5.6.0 contains a breaking change, which should be isolated to a major version. #411

Open dualcyclone opened 2 years ago

dualcyclone commented 2 years ago

Summary

This has taken me a while to find, but our repo is using next-pwa at version ^5.5.2.

So when running an upgrade, it finds the next available minor version and installs it, which is currently 5.6.0.

However, this contains breaking changes which change the method signature, which causes our builds to break with unexpected issues.

Versions

How To Reproduce

Steps to reproduce the behavior:

  1. Create a repo using next-pwa at 5.5.2, using the method signature in use at this version
  2. Upgrade next-pwa to 5.6.0
  3. Observe how the configuration is not used, because it isn't using the new method signature.

Expected Behaviors

This breaking change should have been assigned a major version to prevent package managers automatically updating to the minor version this breaking change contains.

This should likely be reverted in another minor release, then reintroduced in a major release to prevent this happening.