The issue tracker is located in the ckeditor/ckeditor5 repository.
This repository is a monorepo. It contains multiple npm packages.
| Package | Version | Dependencies |
|---|---|---|
eslint-config-ckeditor5 |
 |
 |
eslint-plugin-ckeditor5-rules |
 |
 |
stylelint-config-ckeditor5 |
 |
 |
stylelint-plugin-ckeditor5-rules |
 |
 |
Some of the packages in this repository were previously separate repositories, and are now archived:
- Clone this repository.
- Do
yarn installinside (this package uses yarn workspaces). - You're ready to go!
Tests:
yarn run testCircleCI automates the release process and can release both channels: stable (X.Y.Z) and pre-releases (X.Y.Z-alpha.X, etc.).
Before you start, you need to prepare the changelog entries.
- Make sure the
#masterbranch is up-to-date:git fetch && git checkout master && git pull. - Prepare a release branch:
git checkout -b release-[YYYYMMDD]whereYYYYMMDDis the current day. - Generate the changelog entries:
yarn run release:prepare-changelog.- You can specify the release date by passing the
--dateoption, e.g.,--date=2025-06-11. - By passing the
--dry-runoption, you can check what the script will do without actually modifying the files. - Read all the entries, correct poor wording and other issues, wrap code names in backticks to format them, etc.
- Add the missing
the/aarticles,()to method names, "it's" -> "its", etc. - A newly introduced feature should have just one changelog entry – something like "The initial implementation of the FOO feature." with a description of what it does.
- You can specify the release date by passing the
- Commit all changes and prepare a new pull request targeting the
#masterbranch. - Ping the
@ckeditor/ckeditor-5-platformteam to review the pull request and trigger the release process.
Licensed under the terms of MIT license. For full details about the license, please check the LICENSE.md file.