@ckeditor/ckeditor5-dev-release-tools
Advanced tools
Tools used for releasing CKEditor 5 and related packages.
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.
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
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.
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:
package.json for all released packages,Release: vX.Y.Z.,vX.Y.Z.Note: Before publishing changes you need to bump versions in all dependencies.
The process implemented by the tool:
See the CHANGELOG.md file.
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.
44.0.0-alpha.4 (2024-09-24)
jsonValue() method to get the serialized arguments instead of calling evaluate() method, which may cause unhandled rejection due to destroyed context. (commit)Check out the Versioning policy guide for more information.
<details> <summary>Released packages (summary)</summary>Other releases:
FAQs
Tools used for releasing CKEditor 5 and related packages.
The npm package @ckeditor/ckeditor5-dev-release-tools receives a total of 2,909 weekly downloads. As such, @ckeditor/ckeditor5-dev-release-tools popularity was classified as popular.
We found that @ckeditor/ckeditor5-dev-release-tools demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Socket’s threat research team has detected six malicious npm packages typosquatting popular libraries to insert SSH backdoors.
Security News
MITRE's 2024 CWE Top 25 highlights critical software vulnerabilities like XSS, SQL Injection, and CSRF, reflecting shifts due to a refined ranking methodology.
Security News
In this segment of the Risky Business podcast, Feross Aboukhadijeh and Patrick Gray discuss the challenges of tracking malware discovered in open source softare.