This repository is a monorepo. It contains multiple npm packages.
- Clone this repository.
- Do
yarn installinside (this package uses yarn workspaces). - You're ready to go!
Tests:
yarn run testTests with the debug mode on:
DEBUG=true yarn run testTest a single package:
./node_modules/.bin/mocha packages/ckeditor5-dev-env/tests/* --recursiveCode coverage:
yarn run coverage- 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/ckeditor5-dev-<name>/.
- 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:bump-versionYou can also use the --dry-run option in order to see what this task does.
After bumping the version, you can publish the changes:
npm run release:publishAs in the previous task, the --dry-run option is also available.
Your job's done. You can go now to ckeditor5, remove yarn.lock, potentially update something in package.json, run yarn install and commit that as "Internal: Updated dependencies.".
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.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent