Add CKEditor 5 and ACE libraries using asset-packagist.org in Varbase Editor

Created on 6 May 2024, 8 months ago
Updated 2 June 2024, 7 months ago

Problem/Motivation

A need for a smoother update process before the release of Varbase 9.1.3 and Varbase 10.0.0 stable

Proposed resolution

Add the asset-packagist.org repository

  "repositories": {
    "drupal": {
      "type": "composer",
      "url": "https://packages.drupal.org/8"
    },
    "assets": {
      "type": "composer",
      "url": "https://asset-packagist.org"
    }
  },
varbase_editor-10.0.x branch
    "npm-asset/ace-builds": "~1",
    "npm-asset/northernco--ckeditor5-anchor-drupal": "^0.4.0",
    "npm-asset/ckeditor--ckeditor5-media-embed": "*"

varbase_editor-9.2.x branch

    "npm-asset/ace-builds": "~1",
    "npm-asset/northernco--ckeditor5-anchor-drupal": "^0.4.0",
    "npm-asset/ckeditor--ckeditor5-media-embed": "*"

Old projects needs to add the following under "installer-paths": { in the root composer.json file for the project

      "docroot/libraries/ace": ["npm-asset/ace-builds"],
      "docroot/libraries/ckeditor5-anchor-drupal": ["npm-asset/northernco--ckeditor5-anchor-drupal"],
      "docroot/libraries/ckeditor5/plugins/media-embed": ["npm-asset/ckeditor--ckeditor5-media-embed"],

Also needs to add the following under "drupal-libraries": {

        {"name": "ace", "package": "npm-asset/ace-builds"},
        {"name": "ckeditor5-anchor-drupal", "package": "npm-asset/northernco--ckeditor5-anchor-drupal"},
        {"name": "ckeditor5-media-embed", "package": "npm-asset/ckeditor--ckeditor5-media-embed"}

Remaining tasks

  • ✅ File an issue about this project
  • ✅ Addition/Change/Update/Fix to this project
  • ✅ Testing to ensure no regression
  • âž– Automated unit/functional testing coverage
  • âž– Developer Documentation support on feature change/addition
  • âž– User Guide Documentation support on feature change/addition
  • âž– UX/UI designer responsibilities
  • âž– Accessibility and Readability
  • ✅ Code review from 1 Varbase core team member
  • ✅ Full testing and approval
  • ✅ Credit contributors
  • ✅ Review with the product owner
  • ✅ Update Release Notes and Update Helper on new feature change/addition
  • ✅ Release varbase-10.0.0-rc3 → , varbase_editor-10.0.0-rc6 → , varbase-9.1.3 → , varbase_editor-9.2.2 →

Varbase update type

  • ✅ No Update
  • âž– Optional Update
  • âž– Forced Update
  • âž– Forced Update if Unchanged

User interface changes

  • N/A

API changes

  • N/A

Data model changes

  • N/A

Release notes snippet

📌 Task
Status

Fixed

Version

10.0

Component

Code

Created by

🇯🇴Jordan Rajab Natshah Jordan

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

Comments & Activities

Production build 0.71.5 2024