summary refs log tree commit diff
path: root/docs/upgrade.md
diff options
context:
space:
mode:
authorPatrick Cloke <clokep@users.noreply.github.com>2022-09-28 11:33:31 -0400
committerGitHub <noreply@github.com>2022-09-28 11:33:31 -0400
commitd768c50c0e6822d5c45dc3a4a2efd5ca2bfd21db (patch)
tree7866a8ad04381d703e9abc79d1b49f460d18321a /docs/upgrade.md
parentRevert "Stop returning an unused column when handling new receipts. (#13933)"... (diff)
downloadsynapse-d768c50c0e6822d5c45dc3a4a2efd5ca2bfd21db.tar.xz
Add upgrade notes for changes to receipts replication. (#13932)
Diffstat (limited to '')
-rw-r--r--docs/upgrade.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/upgrade.md b/docs/upgrade.md
index a43233e7c2..c4db19e23d 100644
--- a/docs/upgrade.md
+++ b/docs/upgrade.md
@@ -88,6 +88,18 @@ process, for example:
     dpkg -i matrix-synapse-py3_1.3.0+stretch1_amd64.deb
     ```
 
+# Upgrading to v1.69.0
+
+## Changes to the receipts replication streams
+
+Synapse now includes information indicating if a receipt applies to a thread when
+replicating it to other workers. This is a forwards- and backwards-incompatible
+change: v1.68 and workers cannot process receipts replicated by v1.69 workers, and
+vice versa.
+
+Once all workers are upgraded to v1.69 (or downgraded to v1.68), receipts
+replication will resume as normal.
+
 # Upgrading to v1.68.0
 
 Two changes announced in the upgrade notes for v1.67.0 have now landed in v1.68.0.