CKEditor 5 backwards-compatibility policy needed

Created on 5 June 2024, 12 months ago

Documentation location/URL

Pages which may need an update:

Problem/Motivation

The backwards-compatibility policy for CKEditor 5 appears to be undocumented, despite Drupal 10.x minor updates updating CKEditor to versions which are introducing breaking changes. Most recently, a CKEditor 5 update in the Drupal 10.3 beta contained a change which broke the core functionality of my module CKEditor 5 Icons β†’ . As you can imagine this isn't a fun thing to have happen for a module I previously released for and considered stable on Drupal 10.x.

Although it didn't happen in this case, the possibility also exists for a breaking change to render the editor completely useless on whatever site has the affected plugin enabled.

Proposed resolution

Update the documentation to clarify the official backwards-compatibility policy for the increasing number of projects providing plugins for the CKEditor 5 framework.

πŸ“Œ Task
Status

Active

Component

Missing documentation

Created by

πŸ‡ΊπŸ‡ΈUnited States timurtripp

Live updates comments and jobs are added and updated live.
Sign in to follow issues

Comments & Activities

  • Issue created by @timurtripp
  • πŸ‡³πŸ‡ΏNew Zealand quietone

    This is about core policy, changing project.

  • πŸ‡³πŸ‡ΏNew Zealand quietone
  • Status changed to Needs review 5 days ago
  • πŸ‡³πŸ‡ΏNew Zealand quietone

    The policy for dependencies is Core dependency release cycles β†’ . It is a general guideline for evaluation dependency updates. For the most part, minor versions of Drupal core include the latest minor and patch release of a dependency.

    But CKEditor does not backport bug fixes and major releases often occur in less that 6 months. To get bug fixes Drupal may update to a new major of CKEditor in a new minor release. That happened for 10.3.0-beta1, specifically in πŸ“Œ Update CKEditor 5 to 41.2.0 Fixed , which caused the disruption mentioned in the issue. When there are breaking changes they should be in the release notes but I see there were not for 10.3.0-beta1. That was most likely because that issue was not tagged correctly. And that was a human error and not a problem with a policy.

    Therefore, I think this issue can be closed because the policy is working as designed.

  • πŸ‡ΊπŸ‡ΈUnited States smustgrave

    I can agree with that. May even be a neat gitlab project to see if we can opt into different versions of ckeditor5. Not a core problem but idea came to mind reading this.

  • πŸ‡¬πŸ‡§United Kingdom catch

    The only other option with ckeditor5 would be to move the module to contrib, so that it can release new versions when new ckeditor5 releases come out, and potentially be a bit closer to semver (new major for ckeditor5 majors, new minors for minors, new patch releases for patch releases). However that would be a huge change that would require its own issue and discussion.

Production build 0.71.5 2024