Upcoming
release-2022-02
February 2022 Release

Caveat đŸ”Ĩ

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

  • ℹī¸ 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

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

Newsletter

Webinar

Features

  • Recording: TODO
  • Documentation: TODO

Developers

  • Recording: TODO
  • Slides: TODO

System Requirements

Suggested

Name Version
Node 16
NPM 7
Postgres 13
Elasticsearch 7
Redis 6
Livingdocs Server Docker Image livingdocs/server-base:16
Livingdocs Editor Docker Image livingdocs/editor-base:16
Browser Support Edge >= 80, Firefox >= 74, Chrome >= 80, Safari >= 13.1, iOS Safari >= 13.4, Opera >= 67

Minimal

Name Version
Node 14
NPM 7
Postgres 9.6 (Deprecated Postgres 9 and 10)
Elasticsearch 6.x
Redis 5
Livingdocs Server Docker Image livingdocs/server-base:14.3
Livingdocs Editor Docker Image livingdocs/editor-base:14.3
Browser Support Edge >= 80, Firefox >= 74, Chrome >= 80, Safari >= 13.1, iOS Safari >= 13.4, Opera >= 67

Highlights

Breaking Changes đŸ”Ĩ

Migrate the database

  • Expected duration?
  • Possible data losses?
  • Is it a simple migration? (fast/easy downgradable)
# run grunt migrate to update to the newest database scheme
# migration - 111-add-comments-table.js
#   create comments table + add events to the stream_events_types table
livingdocs-server migrate up

Deprecations

Configuration auth.accessTokenSecret

The configuration auth.accessTokenSecret gets replaced by auth.accessTokenSigningKeys. Old configurations are still valid, but make sure you’ll convert your secret to a JSON web key as soon as you use the new configuration property.

  auth: {
-    accessTokenSecret: "some-secret-for-hmac256-token-signing"
      // Generate the JSON web key using
      //   $ livingdocs-server key-generate convert-hs256 'some-secret-for-hmac256-token-signing'
+    accessTokenSigningKeys: [{"kty":"oct","k":"c29tZS1zZWNyZXQtZm9yLWhtYWMyNTYtdG9rZW4tc2lnbmluZw","kid":"","alg":"HS256","use":"sig"}]
}

Take the existing auth.accessTokenSecret value and convert it to a JSON web key. To ease the conversion, we have the following command that outputs the json for the auth.accessTokenSigningKeys array:

livingdocs-server key-generate convert-hs256 'some-secret-for-hmac256-token-signing'

APIs 🎁

Internal Changes

Other Changes

Features

  • … 🎁

Design

  • … 🎁

Improvements

  • … 🎁

Bugfixes

  • … đŸĒ˛

Patches

Here is a list of all patches after the release has been announced.

Livingdocs Server Patches

Livingdocs Editor Patches

  • v??.?.?: text


    Icon Legend

    • Breaking changes: đŸ”Ĩ
    • Feature: 🎁
    • Bugfix: đŸĒ˛
    • Chore: 🔧