WebStorm 无内置一键生成 Change Log 功能,需借助 conventional-changelog-cli 等 CLI 工具配合 Git 提交记录(须符合 Conventional Commits 规范)自动生成;可通过 External Tools 配置为右键菜单或快捷键实现近似“一键”操作。

WebStorm 本身不提供「一键生成 Change Log」功能,也没有内置的 generate-changelog 命令或菜单项。所谓“一键”,实际依赖外部工具链配合 IDE 的 Git 集成和 Terminal 能力,手动触发但可高度自动化。
Git 提交记录是唯一可靠的数据源
Change Log 的实质是结构化呈现 git log 中的提交信息,尤其依赖符合 Conventional Commits 规范(如 feat:、fix:、chore:)的提交标题。如果团队没统一提交格式,自动生成的 Change Log 很可能语义混乱、分类错误。
- 检查当前分支最近 5 条提交是否规范:
git log -5 --oneline,看是否含feat(api): add timeout option这类模式 - 非规范提交(如
update readme或fix bug)会被conventional-changelog工具忽略或归入Other Changes - WebStorm 的
VCS → Git → Show History可视化查看提交,但无法自动提取语义类型——这步必须靠 CLI 工具
用 conventional-changelog-cli 在 WebStorm Terminal 里跑一次
这是目前最轻量、无需配置插件的落地方式。前提是项目已安装 Node.js 和 conventional-changelog-cli(全局或本地)。
- 在 WebStorm 底部打开
Terminal(快捷键Alt+F12),确保工作目录为项目根路径 - 运行:
npx conventional-changelog-cli -p angular -i CHANGELOG.md -s(angular是最常用 preset;-i指定输出文件,-s表示就地更新而非追加) - 首次运行会生成完整历史;后续只需
git tag -a v1.2.0 -m "release v1.2.0"后再执行该命令,它会自动识别上次 tag 到 HEAD 的区间 - 注意:若提示
Cannot find module 'conventional-changelog-angular',需先npm install -D conventional-changelog-angular
把命令绑定成 WebStorm External Tool 真正接近“一键”
避免每次输长命令,用 External Tools 把它变成右键菜单或快捷键操作。
- 打开
Settings/Preferences → Tools → External Tools,点+添加新工具 - Name 填
Generate Changelog;Program 填npx;Arguments 填conventional-changelog-cli -p angular -i CHANGELOG.md -s;Working directory 设为$ProjectFileDir$ - 添加后,在项目根目录右键 →
External Tools → Generate Changelog即可触发 - 还可为它分配快捷键:进
Keymap → External Tools → Generate Changelog,右键Add Keyboard Shortcut - ⚠️ 注意:WebStorm 的 External Tools 默认不继承 shell 的
PATH,若npx找不到,改 Program 为完整路径(如/usr/local/bin/npx或C:\Users\${USER}\AppData\Roaming\npm\npx.cmd)
真正容易被忽略的是提交信息质量本身——再好的工具也救不了满屏 save、test、xxx 的 git log。自动化只负责“搬运”,语义得靠人写清楚。


















