Skip to content

DOCPS-31571: Add upgrade information #779

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Sep 13, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions source/upgrade.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,12 @@ Upgrade Driver Versions
Overview
--------

On this page, you can learn about any changes you might need to make to
your application to upgrade your driver to a new version without loss of
functionality.
On this page, you can learn how to upgrade your driver to a new version. This page also
includes the changes you must make to your application to upgrade your driver
without losing functionality, if applicable.

How to Upgrade
--------------

Before you upgrade, perform the following actions:

Expand All @@ -35,6 +38,18 @@ Before you upgrade, perform the following actions:
application when upgrading driver versions by using the
:ref:`{+stable-api+} <nodejs-stable-api>`.

To upgrade your driver version, run the following command in your application's
directory:

.. code-block:: bash

npm install mongodb@{+version+}

To upgrade to a different version of the driver, replace the information after the
``@`` symbol with your preferred version number. For more information about the
``npm install`` command, see the `npm-install <https://docs.npmjs.com/cli/v10/commands/npm-install?v=true>`__
npm documentation.

.. _node-breaking-changes:

Breaking Changes
Expand Down