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 test- Fetch all changes and switch to
master! - Execute
npm run changelog:
- This task checks what changed in each package and bumps the version accordingly. If nothing changed at all, it won't create a new changelog entry. If changes were irrelevant (e.g. only depedencies) it will create an "internal changes" entry.
- Scan the logs which are printed by the tool in search for errors (incorrect changelog entries). Incorrect entries (e.g. ones without the type) are being ignored. You may need to create entries for them manually. This is done directly in
CHANGELOG.md(in the root directory). Make sure to verify the proposed version after you modify the changelog.- When unsure what has really changed in this version of a specific package, use
git diff <hash of previous release> packages/<name of the package>/.
- When unsure what has really changed in this version of a specific package, use
After generating the changelog, you are able to release the package.
First, you need to bump the version:
npm run release:prepare-packagesAfter bumping the version, you can publish the changes:
npm run release:publish-packagesYour job's done. You can go now to the root of the repository, potentially update something in package.json, run yarn install and commit that as "Internal: Updated dependencies.".
Licensed under the terms of MIT license. For full details about the license, please check the LICENSE.md file.