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

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: yarn run changelog --branch release-[YYYYMMDD] [--from [GIT_TAG]].

   • By default, the changelog generator uses the latest published tag as a starting point for collecting commits to process.

     The --from modifier option allows overriding the default behavior. It is required when preparing the changelog entries for the next stable release while the previous one was marked as a prerelease, e.g., @alpha.

     Example: Let's assume that the v40.5.0-alpha.0 tag is our latest and that we want to release it on a stable channel. The --from modifier should be equal to --from v40.4.0.

   • This task checks what changed in each package and bumps the version accordingly. It won't create a new changelog entry if nothing changes at all. If changes were irrelevant (e.g., only dependencies), it would make an "internal changes" entry.
   • Scan the logs printed by the tool to search for errors (incorrect changelog entries). Incorrect entries (e.g., ones without the type) should be addressed. 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.
4. Commit all changes and prepare a new pull request targeting the #master branch.
5. Ping the @ckeditor/ckeditor-5-devops 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.

Changelog

43.0.1 (2024-11-13)

Bug fixes

• utils: Upgrade the postcss-nesting package to the latest version to avoid issues with non-supported @nest selectors. Closes ckeditor/ckeditor5#17449. (commit)

Released packages

Check out the Versioning policy guide for more information.

43.0.0 (2024-09-09)

MAJOR BREAKING CHANGES ℹ️

• utils: The git and workspace objects are no longer exported from the package. Also, the following functions are no longer available in the tools object:

• isDirectory()

• isFile()
• isSymlink()
• sortObject()
• readPackageName()
• npmInstall()
• npmUninstall()
• npmUpdate()
• copyTemplateFile()
• copyFile()
• getGitUrlFromNpm()
• removeSymlink()
• clean()

Other changes

• dependency-checker: The dependency checker analyzes dependencies by including the lib/ and bin/ directories as production code. (commit)
• utils: Removed several utilities functions non-used in the CKEditor 5 environment. (commit)
• Added several missing dependencies and devDependencies in packages. Also, removed non-used ones. (commit)

Released packages

Check out the Versioning policy guide for more information.

43.0.0-alpha.0 (2024-09-02)

MAJOR BREAKING CHANGES ℹ️

• utils: The git and workspace objects are no longer exported from the package. Also, the following functions are no longer available in the tools object:

• isDirectory()

• isFile()
• isSymlink()
• sortObject()
• readPackageName()
• npmInstall()
• npmUninstall()
• npmUpdate()
• copyTemplateFile()
• copyFile()
• getGitUrlFromNpm()
• removeSymlink()
• clean()

Other changes

• dependency-checker: The dependency checker analyzes dependencies by including the lib/ and bin/ directories as production code. (commit)
• utils: Removed several utilities functions non-used in the CKEditor 5 environment. (commit)
• Added several missing dependencies and devDependencies in packages. Also, removed non-used ones. (commit)

Released packages

Check out the Versioning policy guide for more information.

42.1.0 (2024-08-29)

Features

• build-tools: Introduced a new loadSourcemaps plugin for loading source maps of external dependencies. (commit)

Bug fixes

• build-tools: Fixed source maps generation for the UMD build. Fixes ckeditor/ckeditor5#16984. (commit)

Released packages

Check out the Versioning policy guide for more information.

42.0.1 (2024-08-13)

Bug fixes

• tests: Added a Chrome flag to prevent displaying the search engine choice screen that disrupts automated tests in windowed mode. Closes ckeditor/ckeditor5#16825. (commit)

Other changes

• stale-bot: Aligned stale bot to recent changes in the GitHub GraphQL API in the repository.labels connection. GitHub recently started returning a lot of mismatched labels for the query and now stale bot ensures that only the required ones are used. Closes ckeditor/ckeditor5#16872. (commit)

Released packages

Check out the Versioning policy guide for more information.

To see all releases, visit the release page.