January 2024 Release - Operations

Upcoming

release-2024-01

January 2024 Release

https://github.com/livingdocsIO/livingdocs-editor/tree/release-2024-01

Caveat 🔥

These are the release notes of the upcoming release (pull requests merged to the main branch).

ℹ️ this document is updated automatically by a bot (pr’s to categorize section)
ℹ️ this document will be roughly updated manually once a week (put PRs + description to the right section)
🔥 We don’t guarantee stable APIs. They can still change until the official release
🔥 Integration against the upcoming release (currently master branch) is at your own risk

PRs to Categorize

To get an overview about new functionality, read the Release Notes. To learn about the necessary actions to update Livingdocs to release-2024-01, read on.

Attention: If you skipped one or more releases, please also check the release-notes of the skipped ones.

Webinar

Feature Webinar Recording: TODO
Feature Webinar Documentation: TODO
Dev Webinar Recording: TODO
Dev Webinar Slides: TODO
Release Newsletter Subscription

System Requirements

Suggested

Name	Version
Node	20
NPM	9
Postgres	15
Elasticsearch OpenSearch	8.x v2.3.0
Redis	7
Livingdocs Server Docker Image	livingdocs/server-base:20
Livingdocs Editor Docker Image	livingdocs/editor-base:20
Browser Support	Edge >= 92, Firefox >= 90, Chrome >= 92, Safari >= 15.4, iOS Safari >= 15.4, Opera >= 78

Minimal

Name	Version
Node	18
NPM	9
Postgres	(Deprecated Postgres v12) 12
Elasticsearch OpenSearch	7.x 1
Redis	6.2
Livingdocs Server Docker Image	livingdocs/server-base:18.3
Livingdocs Editor Docker Image	livingdocs/editor-base:18.5
Browser Support	Edge >= 92, Firefox >= 90, Chrome >= 92, Safari >= 15.4, iOS Safari >= 15.4, Opera >= 78

Breaking Changes 🔥

server Operations

Migrate the Postgres Database 🔥

It’s a simple/fast migration with no expected data losses.

# run `livingdocs-server migrate up` to update to the newest database scheme
livingdocs-server migrate up

server Project config

Custom downstream plugins paramSchema validation changes 🔥

Plugins used in other contexts than the ones stated in the docs, will now report an error during server startup.

All downstream plugins are supported by default in document metadata and media library metadata. But if a downstream plugin is used in include services, creation flows or push messages, that will now cause an error during startup.

If a downstream plugin is being used in an include service params schema the following configuration needs to be added to the plugin declaration:

supportedPluginContexts: [
  'documentMetadata',
  'mediaLibraryEntryMetadata',
  'includeParams'
]

You should remove the serverConfig.useStrictSchemas property if you set it in the previous release.

Please contact your Livingdocs customer manager if you have any problems with the limitations imposed by the supported plugin contexts.

Server PR: Validate plugin configuration in various contexts

TODO: check migration

Deprecations

APIs 🎁

Features

TODO (featureset not 100% defined yet)

Breaking change Custom downstream plugins param schema validation changes is related to this feature so please read it carefully.

Vulnerability Patches

We are constantly patching module vulnerabilities for the Livingdocs Server and Livingdocs Editor as module fixes are available. Below is a list of all patched vulnerabilities included in the release.