Skip to content

Commit

Permalink
DOCSP-32561: Exact versions in upgrade guide (#887)
Browse files Browse the repository at this point in the history
* DOCSP-32561: Exact versions in upgrade guide

* fix

* RR feedback
  • Loading branch information
norareidy authored May 7, 2024
1 parent 1c72eee commit 6d2df34
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 15 deletions.
25 changes: 13 additions & 12 deletions source/upgrade.txt
Original file line number Diff line number Diff line change
Expand Up @@ -70,12 +70,13 @@ The breaking changes in this section are categorized by the major
version releases that introduced them. When upgrading driver versions,
address all the breaking changes between your current version and the
planned upgrade version. For example, if you are upgrading the driver
from v3.x to v5.x, address all breaking changes listed under v4.x and
v5.x.
from v3.x to v5.x, address all breaking changes listed under v4.0 and
v5.0.

.. _node-breaking-changes-v6.x:
.. _node-breaking-changes-v6.0:

Version 6.x Breaking Changes
Version 6.0 Breaking Changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

.. _node-breaking-changes-v5.x:
.. _node-breaking-changes-v5.0:

Version 5.x Breaking Changes
Version 5.0 Breaking Changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

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

.. _node-breaking-changes-v4.x:
.. _node-breaking-changes-v4.0:

Version 4.x Breaking Changes
Version 4.0 Breaking Changes
~~~~~~~~~~~~~~~~~~~~~~~~~~~~

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

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

Expand Down
6 changes: 3 additions & 3 deletions source/whats-new.txt
Original file line number Diff line number Diff line change
Expand Up @@ -244,7 +244,7 @@ What's New in 6.0
.. warning:: Breaking Changes in v6.0

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

The {+driver-short+} v6.0 release includes the following features:
Expand Down Expand Up @@ -538,7 +538,7 @@ What's New in 5.0
.. warning:: Breaking Changes in v5.0

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

New features of the 5.0 {+driver-short+} release include:
Expand Down Expand Up @@ -912,7 +912,7 @@ What's New in 4.0
.. warning:: Breaking Changes in v4.0

This driver version introduces breaking changes. For a list of these changes, see
the :ref:`Version 4.x Breaking Changes section <node-breaking-changes-v4.x>` in
the :ref:`Version 4.0 Breaking Changes section <node-breaking-changes-v4.0>` in
the Upgrade guide.

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

0 comments on commit 6d2df34

Please sign in to comment.