From 6f3432459d1b63285353a94a20bb393f9a87810d Mon Sep 17 00:00:00 2001 From: Richard van der Hoff Date: Wed, 18 Sep 2019 10:52:04 +0100 Subject: [PATCH 1/3] Add some notes on rolling back to v1.3.1. --- UPGRADE.rst | 26 ++++++++++++++++++++++++++ changelog.d/6049.doc | 1 + 2 files changed, 27 insertions(+) create mode 100644 changelog.d/6049.doc diff --git a/UPGRADE.rst b/UPGRADE.rst index 5aaf804902ed..5472a9027f1e 100644 --- a/UPGRADE.rst +++ b/UPGRADE.rst @@ -99,6 +99,32 @@ Synapse will expect these files to exist inside the configured template director default templates, see `synapse/res/templates `_. +Rolling back to v1.3.1 +---------------------- + +If you encounter problems with v1.4.0, it should be possible to roll back to +v1.3.1, subject to the following: + + * The 'room statistics' engine was heavily reworked in this release (see + `#5971 `_), including + significant changes to the database schema, which are not easily + reverted. This will cause the room statistics engine to stop updating when + you downgrade. + + The room statistics are essentially unused in v1.3.1 (they are used to + populate the room directory in v1.4.0), so there should be no loss of + functionality. However, the statistics engine will write errors to the logs, + which can be avoided by setting the following in `homeserver.yaml`: + + .. code:: yaml + + stats: + enabled: false + + Don't forget to re-enable it when you upgrade again, or your room directory + will stop working! + + Upgrading to v1.2.0 =================== diff --git a/changelog.d/6049.doc b/changelog.d/6049.doc new file mode 100644 index 000000000000..e0307bf5c10e --- /dev/null +++ b/changelog.d/6049.doc @@ -0,0 +1 @@ +Add some notes on rolling back to v1.3.1. From 598646f2647a96ee9e04e719f24208631fe8512e Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Wed, 18 Sep 2019 10:54:48 +0100 Subject: [PATCH 2/3] fix formatting --- UPGRADE.rst | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/UPGRADE.rst b/UPGRADE.rst index 5472a9027f1e..ef81bdc59116 100644 --- a/UPGRADE.rst +++ b/UPGRADE.rst @@ -105,24 +105,24 @@ Rolling back to v1.3.1 If you encounter problems with v1.4.0, it should be possible to roll back to v1.3.1, subject to the following: - * The 'room statistics' engine was heavily reworked in this release (see - `#5971 `_), including - significant changes to the database schema, which are not easily - reverted. This will cause the room statistics engine to stop updating when - you downgrade. +* The 'room statistics' engine was heavily reworked in this release (see + `#5971 `_), including + significant changes to the database schema, which are not easily + reverted. This will cause the room statistics engine to stop updating when + you downgrade. - The room statistics are essentially unused in v1.3.1 (they are used to - populate the room directory in v1.4.0), so there should be no loss of - functionality. However, the statistics engine will write errors to the logs, - which can be avoided by setting the following in `homeserver.yaml`: + The room statistics are essentially unused in v1.3.1 (they are used to + populate the room directory in v1.4.0), so there should be no loss of + functionality. However, the statistics engine will write errors to the logs, + which can be avoided by setting the following in `homeserver.yaml`: - .. code:: yaml + .. code:: yaml - stats: - enabled: false + stats: + enabled: false - Don't forget to re-enable it when you upgrade again, or your room directory - will stop working! + Don't forget to re-enable it when you upgrade again, or your room directory + will stop working! Upgrading to v1.2.0 From fd403f16d7a0331bd113a355cf51d79d1e90e774 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Thu, 19 Sep 2019 12:39:26 +0100 Subject: [PATCH 3/3] fix a lie about room directory --- UPGRADE.rst | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/UPGRADE.rst b/UPGRADE.rst index ef81bdc59116..53f3af4ed13c 100644 --- a/UPGRADE.rst +++ b/UPGRADE.rst @@ -111,19 +111,18 @@ v1.3.1, subject to the following: reverted. This will cause the room statistics engine to stop updating when you downgrade. - The room statistics are essentially unused in v1.3.1 (they are used to - populate the room directory in v1.4.0), so there should be no loss of - functionality. However, the statistics engine will write errors to the logs, - which can be avoided by setting the following in `homeserver.yaml`: + The room statistics are essentially unused in v1.3.1 (in future versions of + Synapse, they will be used to populate the room directory), so there should + be no loss of functionality. However, the statistics engine will write errors + to the logs, which can be avoided by setting the following in `homeserver.yaml`: .. code:: yaml stats: enabled: false - Don't forget to re-enable it when you upgrade again, or your room directory - will stop working! - + Don't forget to re-enable it when you upgrade again, in preparation for its + use in the room directory! Upgrading to v1.2.0 ===================