@142vip/changelog

基于 Git 提交信息，生成变更记录，输出 Markdown 格式的日志文件。

安装

CLI 全局命令：changelog / ch；亦可通过 fa changelog（@142vip/fairy-cli）调用。

# npm
npm install @142vip/changelog

# pnpm
pnpm add @142vip/changelog

功能

• ✅ CLI 从 Git 提交生成 CHANGELOG Markdown
• ✅ 可选写入 CHANGELOG.md 并创建 GitHub Release
• ✅ API：changelogApi · parseCliOptions · defineChangelogConfig
• ✅ fa changelog 直连本包，无需 npx changelog
• ✅ Monorepo scopeName 支持
• ✅ 贡献者解析（GitHub API，Node 18+ 原生 fetch）

配置

支持 cosmiconfig 配置文件名 changelog（见 ChangelogDefaultConfig）；CLI 参数可覆盖。

环境变量：GITHUB_TOKEN 或 TOKEN（发布 Release 时必需）。

使用

CLI（standalone）：

npx changelog -h
npx changelog --from v1.0.0 --to v1.1.0 --output CHANGELOG.md --dry-run

fairy-cli：

fa changelog -h
fa changelog --dry-run

程序化：

import { changelogApi } from '@142vip/changelog'

await changelogApi.changelogCoreHandler({ to: 'v1.0.0', dryRun: true })

CLI 主要参数（changelog -h / fa changelog -h）

参数	说明
--token	GitHub Token
--from / --to	提交范围起止标签
--name	Release 名称
--github	GitHub 仓库 owner/repo
--output	CHANGELOG 输出路径
--scopeName	Monorepo 包名
--prerelease	标记为 GitHub Pre-release（默认 false，即 Latest）
--dry-run	试运行
--trace	日志追踪

升级

# 依赖更新
pnpm upgrade @142vip/changelog

参考

• @142vip/changelog
• Conventional Commits
• GitHub Releases API

证书

MIT

Copyright (c) 2019-present, @142vip 储凡

仅供学习参考，商业使用请保留作者版权信息，作者不保证也不承担任何软件的使用风险。