CKEditor test bundles module

The module contains CKEditor 5 builds used for E2E and CKEditor Documents Converter tests. All the available bundles can be found in index.js. All bundles can be built locally with webpack (or other build tools) and all bundles include their own plugin configuration.

Updating CKEditor test bundles

1. Find the bundle(s) that you want to update.
2. Change version of packages in package.json or adjust the plugins in bundles.
3. Build all bundles with pnpm build:bundles.
4. Release new version of ckeditor-test-bundles module.

Adding a new bundle

1. Duplicate a bundle in src/editors. The name of a directory will be used as a name of the bundle.
2. Adjust packages, versions and plugins in the new bundle.
3. Include new bundle in exported object in index.js.
4. Build all bundles with pnpm build:bundles.
5. Release new version of ckeditor-test-bundles module.

Releasing new version of module

Publish token is different from the one used for daily development purposes. You can generate it in your npm account dashboard.

1. Use Publish token in ~/.npmrc file.
2. In the package.json file, set:

• a proper version (updated lastPublicVersion) :

version should stay at 1.0.0 in git. You should change the version temporarily to for example: 5.0.1 (or 5.1.0/6.0.0 depending on semver) and once you release this module change the lastPublicVersion to the released one and revert version change back to 1.0.0 - after merging lastPublicVersion should be the same as the latest version on npm

• lastPublicVersion
• set private to false

3. Make sure that all bundles are built and available in src/bundles directory.
4. Run npm publish.
5. Revert version to 1.0.0 and set private to true in the package.json file.
6. Use the Read-only token back in ~/.npmrc file.

Frozen editors

The following editors have update constraints. Do not update the specified packages beyond the listed versions.

no-plugins-editor — OIM compatibility check

• CKEditor packages (@ckeditor/* in dependencies): frozen at 47.x (patch updates within 47.x are allowed, but not 48+) — v48 drops OIM support
• @ckeditor/ckeditor5-dev-utils (in devDependencies): frozen at <=54.x — v54 is the last version supporting OIM builds
• Other devDependencies (webpack, loaders): CAN be updated
• Purpose: Verifies basic backward compatibility with OIM (Old Installation Method)

multiroot-editor — legacy multiroot support

• CKEditor packages (@ckeditor/* in dependencies): frozen at 36.0.1
• @ckeditor/ckeditor5-dev-utils (in devDependencies): frozen at <=54.x — v54 is the last version supporting OIM builds
• Other devDependencies (webpack, loaders): CAN be updated
• Purpose: Verifies legacy multiroot editor features work correctly with Cloud Services

collaboration-editor-v32 — oldest supported editor version

• CKEditor packages (@ckeditor/* in dependencies): frozen at 32.0.0
• @ckeditor/ckeditor5-dev-utils (in devDependencies): frozen at <=54.x — v54 is the last version supporting OIM builds
• Other devDependencies (webpack, loaders): CAN be updated
• Purpose: Verifies backward compatibility with the oldest CKEditor version we support

Editors with a minimum version

These editors must not go below the listed version.

ai-toolkit-editor — AI Toolkit editor scripts

• CKEditor packages (ckeditor5, ckeditor5-premium-features): at least 48.5.0
• Why: the AI Toolkit snapshot script calls DocumentCompare.makeSnapshot(), which first shipped in 48.5.0
• Purpose: Runs the AI Toolkit MCP flow in the on-premises e2e tests