docs: add version requirements to v7 migration docs 8000 #15361
Merged
Conversation
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
0984c82 to
bc92eae
Compare
There was a problem hiding this comment.
Pull Request Overview
This PR updates the migration guide for Mongoose 7 by clarifying version requirements.
- Added a "Version Requirements" section to the table of contents.
- Introduced explicit version requirements for Node.js (>= 14.0.0) and the MongoDB Node Driver (>= 5.0.0) along with a reference to the driver’s migration guide.
vkarpov15
approved these changes
Apr 22, 2025
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.
Summary
The migration guide from Mongoose v6 to Mongoose v7 does not clarify that it uses MongoDB v5 instead of MongoDB v4.
Looking at your migration guides historically, it looks like an upgrade in the MongoDB Node Driver is expected, but this tripped me up in this instance. To ensure the migration guide relays an accurate scope of the work to migrate, could it include clarification on this?
This is a breaking change as we can set the MongoDB client using
Connection#setClient.Reference: https://mongoosejs.com/docs/7.x/docs/api/connection.html#Connection.prototype.setClient()
If the versions don't align, we can get:
The versions specified were taken from the
package.jsonin your v7.0.0 tag on Git.The wording for the new section is taken from previous migration guides where a change in MongoDB version was clarified, except it's explicit that it refers to the MongoDB Node Driver, as opposed to potentially being confused with the MongoDB Server version.
Instead of what I have written, we could instead take from the Migration Guide for v7 to v8, which instead would look like:
Let me know if you'd prefer that, I can amend the document accordingly.