@ckeditor/ckeditor5-dev-release-tools

CKEditor 5 release tools

Tasks used during a release of CKEditor 5 and related packages.

More information about development tools packages can be found at the following URL: https://github.com/ckeditor/ckeditor5-dev.

Release tools

Usage

npm i --save-dev @ckeditor/ckeditor5-dev-release-tools

Then create a script that run tasks:

// scripts/changelog-self.js: Generate changelog for the current package.
require( '@ckeditor/ckeditor5-dev-release-tools' ).generateChangelogForSinglePackage( /* options */ );

// See the `options` argument:
// https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/ckeditor5-dev-release-tools/lib/tasks/generatechangelogforsinglepackage.js#L25-L43

// scripts/changelog-repos.js: Generate changelog for all dependencies (repository using multiple repositories).
require( '@ckeditor/ckeditor5-dev-release-tools' ).generateChangelogForMonoRepository( /* options */ );

// See the `options` argument:
// https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/ckeditor5-dev-release-tools/lib/tasks/generatechangelogformonorepository.js#L30-L62

// scripts/release-bump-versions.js: Validates and updates version for all packages (includes the package found in options.cwd)
require( '@ckeditor/ckeditor5-dev-release-tools' ).bumpVersions( /* options */ );

// See the `options` argument:
// https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/ckeditor5-dev-release-tools/lib/tasks/bumpversions.js#L20-L27

// scripts/release-packages.js: Publish all changes.
require( '@ckeditor/ckeditor5-dev-release-tools' ).releaseSubRepositories( /* options */ );

// See the `options` argument:
// https://github.com/ckeditor/ckeditor5-dev/blob/master/packages/ckeditor5-dev-release-tools/lib/tasks/releasesubrepositories.js#L20-L27

Generating changelog

This tool can generate a changelog file based on commits in the repository. It can also propose what should be the next release version (according to SemVer).

Read more about the git commit message convention implemented by this tool.

Creating a release for multiple repositories

Note: Before running the bumping versions task you need to generate the changelog for changes in the version to be released.

The process implemented by the tool:

1. Read a new release version from the changelog (the last header),
2. Filter out packages which won't be released (no changes or dependencies has not changed),
3. Update new versions of packages in package.json for all released packages,
4. Commit these changes as Release: vX.Y.Z.,
5. Create a tag vX.Y.Z.

Publishing changes

Note: Before publishing changes you need to bump versions in all dependencies.

The process implemented by the tool:

1. Compares versions released on NPM and GitHub. Based on that, the tool know what should be published. You can call the same script multiple times and nothing wrong happens.
2. If choose publish on NPM: the tool publish changes on NPM.
3. If choose publish on GitHub: the tool creates a GitHub release. Notes for the release are taken from the changelog.
4. If nothing was selected: the tool does nothing. No publish, no push, no creating releases.

Changelog

See the CHANGELOG.md file.

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.