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

Commit

Permalink
Remove upgrade note; expand changelog entry a little.
Browse files Browse the repository at this point in the history
  • Loading branch information
David Robertson committed Oct 7, 2022
1 parent 045cecd commit a722cf5
Show file tree
Hide file tree
Showing 2 changed files with 1 addition and 22 deletions.
2 changes: 1 addition & 1 deletion changelog.d/14085.misc
Original file line number Diff line number Diff line change
@@ -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.
21 changes: 0 additions & 21 deletions docs/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit a722cf5

Please sign in to comment.