0

0

composer如何自动生成CHANGELOG?(结合conventional commits)

裘德小鎮的故事

裘德小鎮的故事

发布时间:2026-03-02 02:07:28

|

660人浏览过

|

来源于php中文网

原创

conventional-changelog 工具依赖规范提交前缀(如 feat:、fix:)才能正确识别类型并生成 changelog;若提交不规范或未打语义化 tag,则输出为空或仅含 “other” 条目,需配合 commitlint + husky 校验、正确配置 composer scripts 并在发版前打 tag。

composer如何自动生成changelog?(结合conventional commits)

conventional-commits 为什么必须先规范提交格式

不按 feat:fix:chore: 等前缀写提交,conventional-changelog 工具根本识别不出类型,生成的 CHANGELOG 就是空的或全是 other 条目。

常见错误现象:conventional-changelog -p angular -i CHANGELOG.md -s 运行后 CHANGELOG.md 没变化,或者只有一行 “### Other”;实际是 Git 历史里混着 git commit -m "update readme" 这类非规范提交。

  • 团队必须统一执行 npm install -D @commitlint/{config-conventional,cli} + 配合 husky 提交前校验
  • conventional-changelog 默认只读取最近一次 tag 到 HEAD 的提交,如果没打过 tag,它会尝试从项目初始提交开始扫——但遇到非规范提交就停,不是跳过
  • Angular preset(-p angular)要求 fix:feat: 必须带括号作用域,比如 fix(auth): token expiry check,缺括号也会被降级为 other

composer.json 里怎么配才能让 changelog 自动生成

Composer 本身不生成 CHANGELOG,真正干活的是 Node.js 工具链。但你可以用 composer run 把它“包”进去,让 PHP 团队也能无感调用。

composer.jsonscripts 区域加一条:

"changelog": "conventional-changelog -p angular -i CHANGELOG.md -s --commit-path ."

注意几个关键参数:

  • -p angular:用 Angular 规范解析提交(最常用,兼容性好)
  • -i CHANGELOG.md:指定输入/输出文件,必须存在(首次运行前 touch CHANGELOG.md
  • -s:直接写入文件,不打印到终端
  • --commit-path .:显式告诉工具从当前目录找 Git 仓库(否则在子目录执行时可能失败)

之后运行 composer run changelog 就等价于跑 Node 命令——前提是项目根目录已安装 conventional-changelog-cli(推荐全局装或 devDependencies 里装)。

Kagi Search
Kagi Search

Kagi是一个注重隐私、以用户为中心的搜索引擎。

下载

生成的 CHANGELOG 版本标题怎么对应 Git tag

默认情况下,conventional-changelog 会把最新一次 tag 当作 “Unreleased” 上方的正式版本标题,比如你刚打了 v1.2.0,它就会在 CHANGELOG 顶部补上 ## [1.2.0](https://...),然后把 v1.2.0HEAD 的提交归到 ## [Unreleased] 下。

容易踩的坑:

  • 没打 tag 就跑命令 → [Unreleased] 下永远空,因为工具找不到上一个锚点
  • tag 名不是语义化格式(如 release-20241.2 缺少补零)→ 工具无法解析版本号,整个分组逻辑失效
  • 想跳过 [Unreleased] 直接生成已发布版本?不行。它必须有这个区块作为占位,否则后续增量更新会错乱

正确做法:每次发版前先 git tag v1.2.0,再 composer run changelog,最后 git add CHANGELOG.md && git commit -m "chore(release): update CHANGELOG for v1.2.0"

PHP 项目里要不要把 Node 工具塞进 vendor

不要。Node 工具和 PHP 生态无关,硬塞进 vendor 会破坏 Composer 的职责边界,还会让 composer install 变慢、CI 构建更难维护。

可行方案只有两个:

  • CI 流水线里单独 npm ci 安装 conventional-changelog-cli,再跑 composer run changelog
  • 本地开发用 nvm 管理 Node 版本,全局安装 npm install -g conventional-changelog-cli,确保所有成员环境一致

关键是别让 PHP 同事去学 npm lockfile 或 node_modules 权限问题——他们只需要知道:改完提交、打好 tag、composer run changelog,三步做完就能推 PR。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
composer是什么插件
composer是什么插件

Composer是一个PHP的依赖管理工具,它可以帮助开发者在PHP项目中管理和安装依赖的库文件。Composer通过一个中央化的存储库来管理所有的依赖库文件,这个存储库包含了各种可用的依赖库的信息和版本信息。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

161

2023.12.25

json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

450

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

546

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

326

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

81

2025.09.10

登录token无效
登录token无效

登录token无效解决方法:1、检查token的有效期限,如果token已经过期,需要重新获取一个新的token;2、检查token的签名,如果签名不正确,需要重新获取一个新的token;3、检查密钥的正确性,如果密钥不正确,需要重新获取一个新的token;4、使用HTTPS协议传输token,建议使用HTTPS协议进行传输 ;5、使用双因素认证,双因素认证可以提高账户的安全性。

6488

2023.09.14

登录token无效怎么办
登录token无效怎么办

登录token无效的解决办法有检查Token是否过期、检查Token是否正确、检查Token是否被篡改、检查Token是否与用户匹配、清除缓存或Cookie、检查网络连接和服务器状态、重新登录或请求新的Token、联系技术支持或开发人员等。本专题为大家提供token相关的文章、下载、课程内容,供大家免费下载体验。

839

2023.09.14

token怎么获取
token怎么获取

获取token值的方法:1、小程序调用“wx.login()”获取 临时登录凭证code,并回传到开发者服务器;2、开发者服务器以code换取,用户唯一标识openid和会话密钥“session_key”。想了解更详细的内容,可以阅读本专题下面的文章。

1087

2023.12.21

Golang 测试体系与代码质量保障:工程级可靠性建设
Golang 测试体系与代码质量保障:工程级可靠性建设

Go语言测试体系与代码质量保障聚焦于构建工程级可靠性系统。本专题深入解析Go的测试工具链(如go test)、单元测试、集成测试及端到端测试实践,结合代码覆盖率分析、静态代码扫描(如go vet)和动态分析工具,建立全链路质量监控机制。通过自动化测试框架、持续集成(CI)流水线配置及代码审查规范,实现测试用例管理、缺陷追踪与质量门禁控制,确保代码健壮性与可维护性,为高可靠性工程系统提供质量保障。

24

2026.02.28

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
第二十四期_PHP8编程
第二十四期_PHP8编程

共86课时 | 3.5万人学习

成为PHP架构师-自制PHP框架
成为PHP架构师-自制PHP框架

共28课时 | 2.6万人学习

第二十三期_PHP编程
第二十三期_PHP编程

共93课时 | 7.4万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号