Document MSW upgrade process and package-specific post-install steps#1049
Merged
Conversation
… steps Add a 'Package-specific upgrade steps' section to the Node dependency update skill. Includes: - A general rule to check each package's changelog/migration guide for custom post-install steps before committing version bumps. - Explicit MSW guidance: mockServiceWorker.js is a generated file that must be regenerated via 'pnpm dlx msw init public/ --save' after any msw version bump. Manual edits to PACKAGE_VERSION or INTEGRITY_CHECKSUM can leave the worker out of sync and silently break browser mocking. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR enhances the Node dependency update skill documentation by adding guidance for package-specific upgrade steps, with a concrete example for msw to prevent mismatched/generated worker artifacts in the UI.
Changes:
- Added a “Package-specific upgrade steps” section instructing contributors to check changelogs/migration guides for required post-upgrade actions.
- Documented the required
mswworker regeneration step (pnpm dlx msw init public/ --save) and cautioned against manual edits to the generated worker constants.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
This pull request adds important guidance to the Node dependency update skill documentation, focusing on package-specific upgrade steps. The main addition is a section detailing how to properly update the
mswpackage and regenerate its associated worker file to prevent runtime issues.Documentation improvements for dependency updates:
Special instructions for
mswupdates:mswpackage, including regenerating themockServiceWorker.jsfile using the recommended MSW CLI command, and emphasized not to manually edit generated constants to avoid breaking browser request mocking.… stepsAdd a 'Package-specific upgrade steps' section to the Node dependency update skill. Includes: