mirror of
https://github.com/suitenumerique/meet.git
synced 2026-07-26 11:58:53 +00:00
1022780027
Add upgrade notes related to the summary changes in v1.23.0
30 lines
1.6 KiB
Markdown
30 lines
1.6 KiB
Markdown
# Upgrade
|
|
|
|
All instructions to upgrade this project from one release to the next will be
|
|
documented in this file. Upgrades must be run sequentially, meaning you should
|
|
not skip minor/major releases while upgrading (fix releases can be skipped).
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
|
|
For most upgrades, you just need to run the django migrations with
|
|
the following command inside your docker container:
|
|
|
|
`python manage.py migrate`
|
|
|
|
(Note : in your development environment, you can `make migrate`.)
|
|
|
|
## [Unreleased]
|
|
|
|
## v1.23.0
|
|
|
|
As part of the 1.23.0 release, the legacy `api/v1` implementation has been removed from the _experimental_ Summary service and Meet has been migrated to the new `api/v2`.
|
|
|
|
**To avoid a breaking change, the Meet backend continues to use the Summary service's v1-compatible API format by default (`SUMMARY_SERVICE_VERSION` setting defaults to `1`).**
|
|
|
|
If you are deploying both Meet and Summary from this repository, you must configure the Meet backend to use the v2 API by setting the following environment variable `SUMMARY_SERVICE_VERSION=2`.
|
|
|
|
If you are upgrading only the Meet deployment while keeping an older Summary v1 compatible deployment, no action is required, as the v1-compatible API remains the default.
|
|
|
|
Note that we plan on removing the legacy `v1` summary compatibility in a future major version. If you have your own implementation for the summary service, we recommend updating its API contract and setting `SUMMARY_SERVICE_VERSION=2`.
|