Skip to content

Patching CKEditor

Jump to bottom
Jonathan Mak edited this page Sep 26, 2018 · 3 revisions

We maintain our own branches/tags (ee-?.?.x / ee-?.?.?) for releasing/patching. You'll need to update these branches before building the ZIP file. The ZIP file should only be built against our 'ee-?.?.x' branches.

  • Portal ee-6.1.x & ee-6.0.x are based on CKEditor 3.6.x. Patch on branch ee-3.6.x.
  • Portal ee-6.2.x has two versions, default (4.0.x) and latest (whatever is in master). Patch on branch ee-4.0.x.
    • Latest (master can be used by setting editor.ckeditor.version, from default to latest, in your _portal-ext.properties- file.
    • If the fix is in Portal and effects CKEditor in master, it likely needs to be backported to ee-6.2.x ckeditor_latest_diff.
  • Portal master is based on CKEditor master. Patch on corresponding CKEditor ee-?.?.x branch.
    • Releases from CKSource, CKEditor's author, should be priority, then if patching is still needed, we patch on top of those releases. We should be trying to use the most recent, compatible, CKEditor release rather than patching.
  • Cherry-pick, if possible, rather than manual patching.
  1. Update, modify, commit
$ git checkout ee-?.?.x
[... cherry-pick, commit, etc.]

IMPORTANT: Commit messages must follow these patterns or they will be rejected.

  • For backporting an original CKEditor commit.
LPS-1234 Original CKEditor commit message.
http://dev.ckeditor.com/ticket/5678
  • For your own custom commits.
LPS-1234 Your own descriptive message.
  1. Version and Change Log
  • For 3.6.x: Update and commit the version/revision numbers in _dev/releaser/release.sh, release.bat.

Example: https://github.com/liferay/liferay-ckeditor/commit/2b71803e858ddfc4150f4b331aa1b9a433734faa

CHANGES.md

Please format entries as:

* [#LPS-56987](https://issues.liferay.com/browse/LPS-56987): Backport [#10042](https://dev.ckeditor.com/ticket/10042): Allow setting meaningful title for inline editable element
* [#LPS-56357](https://issues.liferay.com/browse/LPS-56357): Text Area not working properly during resizing of dialog window.
  1. Send Pull Request to repository owner (everyone else)

IMPORTANT: Be sure you have tested the new CKEditor ZIP in Portal before sending to repository owner. Do not commit ZIP to Portal.

$ git pr -u <REPO_OWNERS_GITHUB_ID> -b ee-?.?.x submit "<JIRA_ID>"
Clone this wiki locally