diff --git a/changelog.d/14085.misc b/changelog.d/14085.misc index 1027d62280af..2d2df70a64ef 100644 --- a/changelog.d/14085.misc +++ b/changelog.d/14085.misc @@ -1 +1 @@ -Rename the `url_preview` extra to `url-preview`, for compatability with poetry-core 1.3.0. +Rename the `url_preview` extra to `url-preview`, for compatability with poetry-core 1.3.0 and [PEP 685](https://peps.python.org/pep-0685/). From-source installations using this extra will need to install using the new name. diff --git a/docs/upgrade.md b/docs/upgrade.md index e5fc6287af4b..b81385b19183 100644 --- a/docs/upgrade.md +++ b/docs/upgrade.md @@ -161,27 +161,6 @@ Synapse will log a warning when a module uses the deprecated method, to help administrators find modules using it. -## Package extra `url_preview` now called `url-preview` - -This is compliant with [PEP 685](https://peps.python.org/pep-0685/#specification) and is necessary to use the URL preview option when Synapse is built with poetry-core 1.3.0 or greater. [#14079](https://github.com/matrix-org/synapse/issues/14079) has some more context. - -If you are installing Synapse from source with this extra specifically named, e.g. with - -``` -pip install /path/to/synapse[url_preview] -``` - -or - -``` -poetry install --extras url_preview -``` - -then you need to change the underscore `_` in `url_preview` to a hyphen `-` when upgrading to Synapse 1.69.0. -No config changes are necessary. - -Installations using Debian packages and Docker images from Matrix.org are not affected. Installations from source that install the `all` extra are not affected. - # Upgrading to v1.68.0 Two changes announced in the upgrade notes for v1.67.0 have now landed in v1.68.0.