-
Notifications
You must be signed in to change notification settings - Fork 29
DOCSP-45211 Upgrade major versions #134
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
stephmarie17
merged 3 commits into
mongodb:standardization
from
stephmarie17:docsp-45211-upgradeVersions
Jan 24, 2025
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
.. _ruby-upgrade: | ||
|
||
======================= | ||
Upgrade Driver Versions | ||
======================= | ||
|
||
.. facet:: | ||
:name: genre | ||
:values: reference | ||
|
||
.. meta:: | ||
:keywords: backwards compatibility, update | ||
|
||
.. contents:: On this page | ||
:local: | ||
:backlinks: none | ||
:depth: 2 | ||
:class: singlecol | ||
|
||
Overview | ||
-------- | ||
|
||
In this section, you can identify the changes you must make to your application | ||
to upgrade your driver to a new version. | ||
|
||
Before you upgrade, perform the following actions: | ||
|
||
- Ensure the new driver version is compatible with the {+mdb-server+} versions | ||
your application connects to and the Ruby versions your application runs on. | ||
To view compatibility information, see the :ref:`Compatibility <ruby-compatibility>` page. | ||
|
||
- Address any breaking changes between the current version of the driver your | ||
application is using and your planned upgrade version in the :ref:`Breaking | ||
Changes <ruby-breaking-changes>` section. | ||
|
||
Starting with version 2.18.0, the driver uses feature flags to manage breaking | ||
changes. This feature allows you to opt into breaking changes before the next | ||
major version release. | ||
|
||
Versioning | ||
---------- | ||
|
||
Each {+driver-short+} release has a version number in the format | ||
``MAJOR.MINOR.PATCH``. The {+driver-short+} uses `Semantic Versioning (SemVer) | ||
<https://semver.org/>`_, which typically means: | ||
|
||
- Breaking changes, enablement of new functionality, and removal of deprecated | ||
functionality will only be done in major version releases. | ||
|
||
- New functionality will be added using feature flags, which must be enabled via | ||
an opt-in configuration change. These feature flags may be added in either | ||
major or minor releases. | ||
|
||
- Functionality may be marked as deprecated in either major or minor releases, | ||
but will not be removed until the next major release, at the earliest. | ||
|
||
- Patch version releases will contain only non-breaking fixes and security | ||
updates. | ||
|
||
.. _ruby-breaking-changes: | ||
|
||
Breaking Changes | ||
---------------- | ||
|
||
A breaking change is a modification in a convention or behavior in | ||
a specific version of the driver that might prevent your application from | ||
working properly if you don't address it before upgrading. | ||
|
||
The breaking changes in this section are categorized by the driver version that | ||
introduced them. When upgrading driver versions, address all the breaking | ||
changes between the current and upgrade versions. | ||
|
||
.. _ruby-breaking-changes-2.20: | ||
|
||
Version 2.20 Breaking Changes | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
This driver version introduces the following breaking change: | ||
|
||
- Discontinues support for Ruby 2.5 and 2.6. Deprecates support for Ruby 2.7 and | ||
JRuby 9.2. |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.