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-changelog
@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-utils
@ckeditor/ckeditor5-dev-translations
@ckeditor/ckeditor5-dev-web-crawler
@ckeditor/typedoc-plugins

Cloning

Note

This project requires pnpm v10 or higher. You can check your version with pnpm --version and update if needed with npm install -g pnpm@latest.

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

Testing

Tests:

pnpm run test

Each package defines its own tests. To run them, change your working directory and use the test script.

Code coverage:

pnpm run coverage

Releasing packages

CircleCI 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.

1. Make sure the #master branch is up-to-date: git fetch && git checkout master && git pull.
2. Prepare a release branch: git checkout -b release-[YYYYMMDD] where YYYYMMDD is the current day.
3. Generate the changelog entries: pnpm run release:prepare-changelog.
4. Commit all changes and prepare a new pull request targeting the #master branch.
5. Ping the @ckeditor/ckeditor-5-platform team to review the pull request and trigger the release process.

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.