Skip to content

Latest commit

 

History

History
135 lines (98 loc) · 7.15 KB

README.md

File metadata and controls

135 lines (98 loc) · 7.15 KB
Raw

CKEditor 5 Package Generator

CircleCI Coverage Status

This repository follows the mono-repository structure. It contains multiple npm packages.

Table of contents

Packages

Name Version Description
ckeditor5-package-generator npm version The tool for creating CKEditor 5 packages.
@ckeditor/ckeditor5-package-tools npm version Development environment tools for CKEditor 5 packages.

Developing the ckeditor5-package-generator repository

  • Clone the repository: git clone [email protected]:ckeditor/ckeditor5-package-generator.git
  • Install required dependencies: yarn install

Creating a package

To create a new package, call the ckeditor5-package-generator executable file. It requires a single argument which is the package name. It must follow the schema: @scope/ckeditor5-package, where @scope is an owner of the package, and ckeditor5-package is the package name. It must start with the ckeditor5- prefix.

The tool will create a new directory called ckeditor5-package with an example plugin called Package and tools for its development.

To use a local version of the @ckeditor/ckeditor5-package-tools package, use the --dev option when executing the command.

node /path/to/repository/packages/ckeditor5-package-generator <packageName> [--dev] [--use-npm] [--use-yarn] [--installation-methods <current|current-and-legacy>] [--name <...>] [--lang <js|ts>] [--verbose]

Options

  • --dev – whether to execute in the development mode. It means that the @ckeditor/ckeditor5-package-tools will not be installed from npm, but from the local file system.
  • --use-npm – use npm to install dependencies in a newly created package.
  • --use-yarn – use yarn to install dependencies in a newly created package.
  • --installation-methods – (values: current | current-and-legacy) choose which installation methods of CKEditor 5 do you want to support? If omitted, the script will ask the user to choose manually.
  • --name – define a class name to be different from the package name.
  • --lang – (values: js | ts) choose whether the created package should use JavaScript or TypeScript. If omitted, the script will ask the user to choose manually.
  • --verbose – (alias: -v) print additional logs about the current executed task.

Developing the package

Available scripts and their modifiers are described in the README.md file of the ckeditor5-package-generator package.

Package metadata

The ckeditor5-metadata.json file contains data of the package that allows for an automated detection of plugins and processing them by external scripts. Information about how this file should be maintained is available in the official guide. Keep in mind that this file has no effect on how the plugin work.

Developing tools in the repository

When creating a new package with the --dev option, the local version of the @ckeditor/ckeditor5-package-tools will be installed instead of its npm version.

However, applying changes in the local repository does not impact an already created package. Hence, you need to create a link between the local repository and the new package.

# The assumption here is your current working directory points to the root directory in the repository.
cd packages/ckeditor5-package-tools
yarn link

# Then, go to the newly created package.
cd /path/to/new/package/ckeditor5-foo
yarn link @ckeditor/ckeditor5-package-tools

Now, the newly created package uses changes from the local repository.

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

The ckeditor5-package-generator tool is available under MIT license.

All packages created with the tool are also available under the MIT license.