Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit a722cf5

Browse files
author
David Robertson
committed
Remove upgrade note; expand changelog entry a little.
1 parent 045cecd commit a722cf5

File tree

2 files changed

+1
-22
lines changed

2 files changed

+1
-22
lines changed

changelog.d/14085.misc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
Rename the `url_preview` extra to `url-preview`, for compatability with poetry-core 1.3.0.
1+
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.

docs/upgrade.md

Lines changed: 0 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -161,27 +161,6 @@ Synapse will log a warning when a module uses the deprecated method, to help
161161
administrators find modules using it.
162162

163163

164-
## Package extra `url_preview` now called `url-preview`
165-
166-
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.
167-
168-
If you are installing Synapse from source with this extra specifically named, e.g. with
169-
170-
```
171-
pip install /path/to/synapse[url_preview]
172-
```
173-
174-
or
175-
176-
```
177-
poetry install --extras url_preview
178-
```
179-
180-
then you need to change the underscore `_` in `url_preview` to a hyphen `-` when upgrading to Synapse 1.69.0.
181-
No config changes are necessary.
182-
183-
Installations using Debian packages and Docker images from Matrix.org are not affected. Installations from source that install the `all` extra are not affected.
184-
185164
# Upgrading to v1.68.0
186165

187166
Two changes announced in the upgrade notes for v1.67.0 have now landed in v1.68.0.

0 commit comments

Comments
 (0)