Skip to content

Commit

Permalink
Update upgrade section
Browse files Browse the repository at this point in the history
Signed-off-by: Derek McGowan <[email protected]>
  • Loading branch information
dmcgowan committed Jan 22, 2025
1 parent 55018f3 commit d8262af
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,10 +247,11 @@ no compatibility guarantees for upgrades that span multiple, _minor_ releases.
For example, 1.0.0 to 1.2.0 is not supported. One should first upgrade to 1.1,
then 1.2.

There are no compatibility guarantees with upgrades to _major_ versions. For
example, upgrading from 1.0.0 to 2.0.0 may require resources to migrated or
integrations to change. Each major version will be supported for at least 1
year with bug fixes and security patches.
There are no compatibility guarantees with upgrades to _major_ versions. For 2.0, migration was
added to ensure upgrading from 1.6 or 1.7 to 2.0 is easy. The latest releases of 1.6 and 1.7 provide
deprecation warnings if any configuration is used which is incompatible with 2.0. If deprecation
warnings are showing up, the configuration can be safely upgrade in 1.6 or 1.7 before upgrading to
2.0. Once no deprecation warnings are showing up, the upgrade to 2.0 is completely compatible.

## Public API Stability

Expand Down

0 comments on commit d8262af

Please sign in to comment.