CKEditor 5 development tools packages

Packages

This repository is a monorepo. It contains multiple npm packages.

Package	Version
@ckeditor/ckeditor5-dev-bump-year
@ckeditor/ckeditor5-dev-ci
@ckeditor/ckeditor5-dev-dependency-checker
@ckeditor/ckeditor5-dev-docs
@ckeditor/ckeditor5-dev-release-tools
@ckeditor/ckeditor5-dev-tests
@ckeditor/ckeditor5-dev-transifex
@ckeditor/ckeditor5-dev-utils
@ckeditor/ckeditor5-dev-translations
@ckeditor/ckeditor5-dev-web-crawler
@ckeditor/jsdoc-plugins
@ckeditor/typedoc-plugins

Cloning

1. Clone this repository.
2. Do yarn install inside (this package uses yarn workspaces).
3. You're ready to go!

Testing

Tests:

yarn run test

Tests with the debug mode on:

DEBUG=true yarn run test

Test a single package:

./node_modules/.bin/mocha packages/ckeditor5-dev-release-tools/tests/* --recursive

Code coverage:

yarn run coverage

Releasing packages

Changelog

1. Fetch all changes and switch to master!
2. 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/ckeditor5-dev-<name>/.

Publishing

After generating the changelog, you are able to release the package.

First, you need to bump the version:

npm run release:prepare-packages

After bumping the version, you can publish the changes:

npm run release:publish-packages

Your job's done. You can go now to ckeditor5, remove yarn.lock, potentially update entries in package.json, run yarn install and commit that as "Internal: Updated dependencies.".

License

Licensed under the terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file.