From 71c930750928998624c13cc40551267f6edb03bc Mon Sep 17 00:00:00 2001 From: Andrew Morgan Date: Mon, 11 May 2020 15:05:46 +0100 Subject: [PATCH] Move next version notes from changelog to upgrade notes --- CHANGES.md | 19 +++++-------------- UPGRADE.rst | 10 ++++++++++ 2 files changed, 15 insertions(+), 14 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index 04ddf1da2..fa2be3515 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,6 +1,7 @@ Synapse 1.13.0rc1 (2020-05-11) ============================== + Features -------- @@ -79,6 +80,10 @@ Improved Documentation Deprecations and Removals ------------------------- +Plugins using the `complete_sso_login` method of `synapse.module_api.ModuleApi` +should update to using the async/await version `complete_sso_login_async` which +includes additional checks. The non-async version is considered deprecated. + - Remove nonfunctional `captcha_bypass_secret` option from `homeserver.yaml`. ([\#7137](https://github.com/matrix-org/synapse/issues/7137)) @@ -136,20 +141,6 @@ Internal Changes - Run group attestation renewal in series rather than parallel for performance. ([\#7442](https://github.com/matrix-org/synapse/issues/7442)) -Next version -============ - -* New templates (`sso_auth_confirm.html`, `sso_auth_success.html`, and - `sso_account_deactivated.html`) were added to Synapse. If your Synapse is - configured to use SSO and a custom `sso_redirect_confirm_template_dir` - configuration then these templates will need to be duplicated into that - directory. - -* Plugins using the `complete_sso_login` method of `synapse.module_api.ModuleApi` - should update to using the async/await version `complete_sso_login_async` which - includes additional checks. The non-async version is considered deprecated. - - Synapse 1.12.4 (2020-04-23) =========================== diff --git a/UPGRADE.rst b/UPGRADE.rst index d1408be2a..5a96b3919 100644 --- a/UPGRADE.rst +++ b/UPGRADE.rst @@ -78,6 +78,7 @@ for example: Upgrading to v1.13.0 ==================== + Incorrect database migration in old synapse versions ---------------------------------------------------- @@ -105,6 +106,15 @@ affected can be repaired as follows: 2. Restart synapse. +New Single Sign-on HTML Templates +--------------------------------- + +New templates (`sso_auth_confirm.html`, `sso_auth_success.html`, and +`sso_account_deactivated.html`) were added to Synapse. If your Synapse is +configured to use SSO and a custom `sso_redirect_confirm_template_dir` +configuration then these templates will need to be duplicated into that +directory. + Upgrading to v1.12.0 ====================