Skip to content

Commit 7fb6bf1

Browse files
committed
DOCSP-32561: Exact versions in upgrade guide (#887)
* DOCSP-32561: Exact versions in upgrade guide * fix * RR feedback (cherry picked from commit 6d2df34) (cherry picked from commit f36bcf0) (cherry picked from commit a632359) (cherry picked from commit 9b035b7)
1 parent 4aecf42 commit 7fb6bf1

File tree

2 files changed

+19
-36
lines changed

2 files changed

+19
-36
lines changed

source/upgrade.txt

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -70,17 +70,17 @@ The breaking changes in this section are categorized by the major
7070
version releases that introduced them. When upgrading driver versions,
7171
address all the breaking changes between your current version and the
7272
planned upgrade version. For example, if you are upgrading the driver
73-
from v3.x to v5.x, address all breaking changes listed under v4.x and
74-
v5.x.
73+
from v3.x to v5.x, address all breaking changes listed under v4.0 and
74+
v5.0.
7575

7676
.. _node-breaking-changes-v5.x:
77+
.. _node-breaking-changes-v5.0:
7778

78-
Version 5.x Breaking Changes
79+
Version 5.0 Breaking Changes
7980
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8081

81-
- Driver versions 5.x are not compatible with Node.js
82-
v12 or earlier. If you want to use this version of the driver, you must
83-
use Node.js v14.20.1 or greater.
82+
- The driver is no longer compatible with Node.js v12 or earlier. If you want to use
83+
this version of the driver, you must use Node.js v14.20.1 or greater.
8484

8585
- The driver removes support for callbacks in favor of a promise-based API.
8686
The following list provides some strategies for callback users to adopt this
@@ -128,13 +128,13 @@ Version 5.x Breaking Changes
128128
- ``AsyncIterator`` interface removed in favor of ``AsyncGenerator``
129129

130130
.. _node-breaking-changes-v4.x:
131+
.. _node-breaking-changes-v4.0:
131132

132-
Version 4.x Breaking Changes
133+
Version 4.0 Breaking Changes
133134
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
134135

135-
- Driver versions 4.x are not compatible with Node.js
136-
v12.8 or earlier. If you want to use this version of the driver, You must
137-
use Node.js v12.9 or greater.
136+
- The driver is no longer compatible with Node.js v12.8 or earlier. If you
137+
want to use this version of the driver, you must use Node.js v12.9 or greater.
138138

139139
- ``Cursor`` types no longer extend ``Readable`` directly.
140140

source/whats-new.txt

Lines changed: 9 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -237,32 +237,9 @@ What's New in 5.0
237237

238238
.. important:: Breaking Changes in v5.0
239239

240-
- Version 5.0 of the {+driver-short+} is not compatible with Node.js
241-
v12 or earlier. If you want to use this version of the driver, You must
242-
use Node.js v14.20.1 or greater.
243-
244-
- This release removes support for callbacks in favor of a promise-based API.
245-
The following list provides some strategies for callback users to adopt this
246-
version:
247-
248-
- Migrate to the promise-based API (recommended)
249-
- Use the promise-based API and ``util.callbackify``
250-
- Add ``mongodb-legacy`` to continue using callbacks
251-
252-
For more information about these strategies, see
253-
`Changes in the MongoDB Node.js Driver v5 <https://github.com/mongodb/node-mongodb-native/blob/main/etc/notes/CHANGES_5.0.0.md>`__.
254-
255-
- This release removes support for the ``Collection.insert()``,
256-
``Collection.update()``, and ``Collection.remove()`` helper methods.
257-
The following list provides instructions on how to replace the
258-
functionality of the removed methods:
259-
260-
- Migrate from ``Collection.insert()`` to ``insertOne()`` or ``insertMany()``
261-
- Migrate from ``Collection.update()`` to ``updateOne()`` or ``updateMany()``
262-
- Migrate from ``Collection.remove()`` to ``deleteOne()`` or ``deleteMany()``
263-
264-
To view a full list of breaking changes introduced in this version, see the :ref:`Breaking
265-
Changes section <node-breaking-changes-v5.x>` in the Upgrade guide.
240+
This driver version introduces breaking changes. For a list of these changes, see
241+
the :ref:`Version 5.0 Breaking Changes section <node-breaking-changes-v5.0>` in the
242+
Upgrade guide.
266243

267244
New features of the 5.0 {+driver-short+} release include:
268245

@@ -632,6 +609,12 @@ New features of the 4.1 Node.js driver release include:
632609
What's New in 4.0
633610
-----------------
634611

612+
.. warning:: Breaking Changes in v4.0
613+
614+
This driver version introduces breaking changes. For a list of these changes, see
615+
the :ref:`Version 4.0 Breaking Changes section <node-breaking-changes-v4.0>` in
616+
the Upgrade guide.
617+
635618
.. important::
636619

637620
In this release of the driver, the deprecated ``collection.count()`` method was inadvertently changed to

0 commit comments

Comments
 (0)