Skip to content

Commit 5becb4a

Browse files
committed
Add section on avoiding breaking changes
1 parent a5216f3 commit 5becb4a

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/SRU/reference/exception-Valkey-Updates.rst

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,20 @@ the integration of Valkey with Ubuntu, specifically when starting valkey-server
8282
and running standard cli commands, along with issues in setup and compatibility
8383
with Redis if relevant.
8484

85+
.. _valkey_avoiding_breaking_changes:
86+
87+
Avoiding Breaking Changes
88+
-------------------------
89+
90+
In order to confirm that upstream continues to match our expectation of
91+
backwards compatibility in micro releases, additional due diligence must be
92+
done by whoever prepares the SRU. Prior to merging, version release notes and
93+
announcements from upstream must be checked for backwards-incompatible changes.
94+
Any change that may fit this description must be noted in the bug report. Also,
95+
prior to uploading, discuss with the SRU team as to how to handle the changes.
96+
This may result in a reversion of the backwards-incompatible changes through
97+
patches.
98+
8599
Valkey Update Process
86100
----------------------
87101

@@ -94,6 +108,7 @@ To do this we will:
94108

95109
- Add tasks to all Ubuntu releases which will be updated.
96110
- Add a link to the upstream changelog and list major changes.
111+
- Look through changelogs and announcements to check for backwards-incompatible changes, and note them down.
97112

98113
#. Make sure the development release contains the fixes that will be added. In general this should be the case as long as it is up to date with its associated micro release version.
99114
#. Setup merges with each new version.
@@ -119,6 +134,8 @@ Valkey SRU template
119134
TODO: List updates, CVE fixes, and relevant bug fixes
120135
TODO: Add a link to the upstream changelog
121136
137+
TODO: Specifically note any backwards-incompatible changes or features added by upstream and their announcements/release notes and relevant commits.
138+
122139
[Test Plan]
123140
124141
TODO: Check DEP-8 and reverse-depends DEP-8 tests pass

0 commit comments

Comments
 (0)