docs: Add section on workspace version bumps #8019
Open
+37
−0
Conversation
This file contains 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
wraithgar
reviewed
Jan 10, 2025
| #### Note on `--save` | ||
| By default, `npm version -ws` will bump the versions in each workspace without automatically | ||
| updating dependency references across workspaces. Including the `--save` flag triggers a | ||
| minimal reify operation that updates references **if** your semver range allows it. |
There was a problem hiding this comment.
minima reify operation is more info that folks probably want or need here. We just need to document what it does, not how.
There was a problem hiding this comment.
removed the "minima reify operation" and any mention of the internal npm mechanics
wraithgar
reviewed
Jan 10, 2025
| you must broaden the range (e.g., `">=1.0.0 <3.0.0"`, `"^1.0.0 || ^2.0.0"`, etc.) or | ||
| manually update it to allow a major bump. | ||
|
|
||
| It's important to note, Reify takes place even without the `--save` flag. However, in that case, |
There was a problem hiding this comment.
We don't need this last paragraph.
There was a problem hiding this comment.
removed the last paragraph.
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 PR enhances the npm version documentation by adding a dedicated section, "Version Bumps with Workspaces", to clarify the behavior of npm version -ws in the context of inter-workspace dependencies. The new section provides detailed explanations and examples to address common questions about how workspace dependency updates are handled.
References
Related to #4578