Skip to content

Commit 74aee82

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)
1 parent 40359d1 commit 74aee82

File tree

2 files changed

+22
-16
lines changed

2 files changed

+22
-16
lines changed

source/upgrade.txt

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -70,12 +70,13 @@ 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-v6.x:
77+
.. _node-breaking-changes-v6.0:
7778

78-
Version 6.x Breaking Changes
79+
Version 6.0 Breaking Changes
7980
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8081

8182
- Version 6.0 of the {+driver-short+} requires Node.js v16.20.1 or later.
@@ -84,7 +85,7 @@ Version 6.x Breaking Changes
8485
- The driver removes support for the ``collStats`` operation. Use the
8586
:manual:`$collStats </reference/operator/aggregation/collStats>` aggregation operator
8687
instead.
87-
- The driver deprecates all of the ``ssl``-prefixed options and the
88+
- The driver removes all the deprecated ``ssl``-prefixed options and the
8889
``tlsCertificateFile`` option in the ``MongoClientOptions`` type.
8990
Create a ``SecureContext`` object or set the ``tls``-prefixed options
9091
in your ``MongoClientOptions`` instance instead.
@@ -138,13 +139,13 @@ Version 6.x Breaking Changes
138139
- Raised the optional ``zstd`` dependency minimum version to 1.1.0.
139140

140141
.. _node-breaking-changes-v5.x:
142+
.. _node-breaking-changes-v5.0:
141143

142-
Version 5.x Breaking Changes
144+
Version 5.0 Breaking Changes
143145
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
144146

145-
- Driver versions 5.x are not compatible with Node.js
146-
v12 or earlier. If you want to use this version of the driver, you must
147-
use Node.js v14.20.1 or greater.
147+
- The driver is no longer compatible with Node.js v12 or earlier. If you want to use
148+
this version of the driver, you must use Node.js v14.20.1 or greater.
148149

149150
- The driver removes support for callbacks in favor of a promise-based API.
150151
The following list provides some strategies for callback users to adopt this
@@ -192,13 +193,13 @@ Version 5.x Breaking Changes
192193
- ``AsyncIterator`` interface removed in favor of ``AsyncGenerator``
193194

194195
.. _node-breaking-changes-v4.x:
196+
.. _node-breaking-changes-v4.0:
195197

196-
Version 4.x Breaking Changes
198+
Version 4.0 Breaking Changes
197199
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
198200

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

203204
- ``Cursor`` types no longer extend ``Readable`` directly.
204205

source/whats-new.txt

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,8 +121,8 @@ What's New in 6.0
121121

122122
.. warning:: Breaking Changes in v6.0
123123

124-
This driver version introduces breaking changes. For a list of these changes, see
125-
the :ref:`Version 6.x Breaking Changes section <node-breaking-changes-v6.x>` in the
124+
This driver version introduces breaking changes. For a list of these changes, see
125+
the :ref:`Version 6.0 Breaking Changes section <node-breaking-changes-v6.0>` in the
126126
Upgrade guide.
127127

128128
The {+driver-short+} v6.0 release includes the following features:
@@ -415,8 +415,8 @@ What's New in 5.0
415415

416416
.. warning:: Breaking Changes in v5.0
417417

418-
This driver version introduces breaking changes. For a list of these changes, see
419-
the :ref:`Version 5.x Breaking Changes section <node-breaking-changes-v5.x>` in the
418+
This driver version introduces breaking changes. For a list of these changes, see
419+
the :ref:`Version 5.0 Breaking Changes section <node-breaking-changes-v5.0>` in the
420420
Upgrade guide.
421421

422422
New features of the 5.0 {+driver-short+} release include:
@@ -789,8 +789,13 @@ What's New in 4.0
789789

790790
.. warning:: Breaking Changes in v4.0
791791

792+
<<<<<<< HEAD
792793
This driver version introduces breaking changes. For a list of these changes, see
793794
the :ref:`Version 4.x Breaking Changes section <node-breaking-changes-v4.x>` in
795+
=======
796+
This driver version introduces breaking changes. For a list of these changes, see
797+
the :ref:`Version 4.0 Breaking Changes section <node-breaking-changes-v4.0>` in
798+
>>>>>>> 6d2df34 (DOCSP-32561: Exact versions in upgrade guide (#887))
794799
the Upgrade guide.
795800

796801
New features of the 4.0 Node.js driver release include:

0 commit comments

Comments
 (0)