CKEditor 5 Changelog
A development tool for handling the changelog preparation in CKEditor 5.
Installation
Install the package to use it.
npm i --save-dev @ckeditor/ckeditor5-dev-changelog
API
This package provides a command-line interface (CLI) and a JavaScript API for generating changelogs.
Binary scripts
The ckeditor5-dev-changelog-create-entry script allows you to create a new changelog entry. By default, it will be created in the
.changelog/ directory.
JavaScript API
The JavaScript/TypeScript API can be used as follows:
import { generateChangelogForMonoRepository, generateChangelogForSingleRepository } from '@ckeditor/ckeditor5-dev-changelog';
await generateChangelogForMonoRepository( { /* options */ } );
await generateChangelogForSingleRepository( { /* options */ } );
Review the types to see the available options.
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.
关于 @ckeditor/ckeditor5-dev-changelog 的常见问题@ckeditor/ckeditor5-dev-changelog 是什么? A CKEditor 5 development tool for handling changelogs.
如何安装 @ckeditor/ckeditor5-dev-changelog? 在项目目录运行 npm install @ckeditor/ckeditor5-dev-changelog,或使用 pnpm add / yarn add / bun add。它还提供命令行工具 ckeditor5-dev-changelog-create-entry,可以用 npx ckeditor5-dev-changelog-create-entry 直接运行。
@ckeditor/ckeditor5-dev-changelog 支持 TypeScript 吗? 支持。包内自带 TypeScript 类型声明(package.json 声明了 types 入口),安装后即可获得类型提示,无需再安装 @types 包。
@ckeditor/ckeditor5-dev-changelog 支持 ESM 还是 CommonJS? 以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。
@ckeditor/ckeditor5-dev-changelog 需要什么版本的 Node.js? package.json 的 engines 字段要求 Node.js >=26.10.0。版本不符时 npm 默认只给出警告,开启 engine-strict 后会拒绝安装。
@ckeditor/ckeditor5-dev-changelog 可以商用吗? @ckeditor/ckeditor5-dev-changelog 使用 GPL-2.0-or-later 许可。强 Copyleft:分发包含该代码的软件时,整个作品需以兼容的 GPL 许可开源。仅在内部使用、不对外分发时不触发此义务。以上为概括,不构成法律意见,请以许可原文为准。
@ckeditor/ckeditor5-dev-changelog 的下载量有多少? 根据 npm 官方下载统计,@ckeditor/ckeditor5-dev-changelog 在 2026/10/10 – 2026/11/08 这 30 天内被下载 9,534 次,日均约 318 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入,适合横向比较热度,不能直接等同于使用人数。
@ckeditor/ckeditor5-dev-changelog 还在维护吗? 最新版本 63.1.3 发布于 2026/11/09(今天);至今共发布 98 个版本,其中过去 12 个月发布了 80 个;首次发布于 2025/06/10。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。