讲师中心 微信公众号
AI工具推荐 视频效率加速

基于Git提交记录自动更新Composer变更日志教程

轻明小哥_3350

轻明小哥_3350

发布时间:2026-09-19 08:58:12

|

494人浏览过

|

来源于php中文网

原创

Git提交记录不能直接生成Composer可用变更日志,因Composer不读取Git日志或composer.json历史diff;需脚本提取composer.json/composer.lock修改提交,用jq比对require字段变化,生成CHANGELOG.md片段,且须人工校验确保准确。

基于git提交记录自动更新composer变更日志教程

Git 提交记录本身不能直接生成 Composer 可用的变更日志——因为 Composer 不读取 Git 日志,也不解析 composer.json 的历史 diff。所谓“自动更新”,实际是靠脚本把 Git 提交中与依赖相关的改动(如 composer.jsoncomposer.lock 修改)提取出来,再格式化为人类可读的 CHANGELOG.md 片段。

怎么从 Git 提交里识别出真正的依赖变更

仅靠 git log --oneline 看不到哪些提交动了依赖。必须结合文件路径过滤和内容比对:

  • 先用 git log --pretty=format:"%h %s" --name-only -m --follow -- composer.json composer.lock 找出所有修改过这两个文件的提交
  • 再对每个提交,用 git show <commit>:composer.jsongit show <commit>^:composer.json 做 JSON diff(推荐 jqdiff -u),只保留 requirerequire-devversion 字段的变化
  • 忽略仅改注释、空格、或仅更新 composer.lock 但没动 composer.json 的提交(这类通常是 composer install 触发的,不算“语义变更”)

为什么不能直接用 conventional commits 规范来标记依赖变更

Conventional Commits(如 chore(deps): bump laravel/framework from 10.10 to 10.11)看着干净,但实际落地有硬伤:

  • 没人强制每次 composer update 都写这种格式,团队执行率低
  • CI 脚本无法验证 commit message 是否准确——比如你写了 bump foo/bar,但实际 composer.json 里根本没这个包
  • 版本号可能被手动编辑(如从 ^2.3 改成 ^2.4),而 commit message 没同步更新,导致日志错乱

更可靠的做法是:让脚本自己从 composer.json 的 diff 中提取包名和版本变化,再拼成标准句式,不依赖人写对 message。

MergeIQ: Automatically Score & Prioritise PR Complexity for GitLab and GitHub
MergeIQ: Automatically Score & Prioritise PR Complexity for GitLab and GitHub

使用四维度框架评估任意 GitLab MR 或 GitHub PR 的复杂度:规模(20%),认知负荷(30%),审查工作量(30%),风险/影响(20%)...

下载

如何用 shell + jq 快速生成最小可用变更日志片段

以下脚本只处理最近一次涉及依赖的提交,输出 Markdown 格式条目,适合集成进 CI 后追加到 CHANGELOG.md:

#!/bin/bash
COMMIT=$(git log -n1 --pretty=%H --name-only -m --follow -- composer.json composer.lock 2>/dev/null)
if [ -z "$COMMIT" ]; then exit 0; fi
<h1>提取上一版和当前版的 require/require-dev</h1><p>OLD_JSON=$(git show ${COMMIT}^:composer.json 2>/dev/null | jq -r '.require, .["require-dev"] | keys[]?')
NEW_JSON=$(git show ${COMMIT}:composer.json 2>/dev/null | jq -r '.require, .["require-dev"] | keys[]?')</p><h1>找出新增/升级/移除的包(简化版,生产环境建议用更严谨的 diff 工具)</h1><p>ADDED=$(comm -13 <(echo "$OLD_JSON" | sort) <(echo "$NEW_JSON" | sort) | sed 's/^/- /')
REMOVED=$(comm -23 <(echo "$OLD_JSON" | sort) <(echo "$NEW_JSON" | sort) | sed 's/^/- /')</p><p>if [ -n "$ADDED$REMOVED" ]; then
echo "### Dependencies"
echo "$ADDED"
echo "$REMOVED"
echo ""
fi</p>

注意:jq 必须已安装;comm 要求输入已排序;该脚本不处理版本号变化细节(如从 1.2.31.2.4),只做增删判断——如果需要精确版本差,得用 jq 分别提取两个版本的 value 并比对。

最容易被忽略的兼容性陷阱

生成的日志若用于发布流程(如 GitHub Releases),要注意三件事:

  • composer.lock 的变更可能跨多个提交(例如先改 composer.json,再 composer update 提交 lock),脚本必须能合并识别,否则漏掉关键升级
  • 某些私有包使用 vcspackage 类型仓库,其版本字段可能是 dev-main1.0.x-dev,直接字符串比对会误判为“未变”
  • PHP 版本约束(config.platform.php)也算依赖环境变更,但不在 require 字段里——如果脚本只盯 require,就会漏掉这个重要兼容性提示

真正稳定的方案不是追求“全自动”,而是把脚本做成“半自动校验器”:它列出所有可疑变更,人工确认后一键插入日志——省时间,不省责任。

热门AI工具

更多
UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

墨刀AI
墨刀AI Hot

一款AI图像与设计工具,主要用于产品经理的专属智能体,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

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

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

304

2023.12.25

Composer 安装与快速入门指南
Composer 安装与快速入门指南

面向 PHP 开发新手,详细介绍 Composer 的下载安装方式(本地安装与全局安装)、国内镜像源(阿里云/腾讯云)加速配置、composer.json 与 composer.lock 文件的作用解析、require/install/update 等核心命令的使用方法,帮助开发者快速掌握 PHP 依赖管理的基本工作流。

463

2026.04.10

Composer 依赖管理与版本控制实战
Composer 依赖管理与版本控制实战

深入讲解 Composer 的依赖管理机制,涵盖语义化版本号规范、版本约束符(^、~、*、>=)的区别与最佳实践、composer.lock 在团队协作中的锁定策略、依赖冲突的排查与解决方法、require-dev 与生产依赖的分离管理、平台依赖检查(platform-check)等进阶内容,帮助开发者在项目中精准控制依赖版本、避免"依赖地狱"。

267

2026.04.10

Composer 自定义包开发与发布教程合集
Composer 自定义包开发与发布教程合集

以实际项目为导向,讲解如何从零创建一个符合规范的 Composer 包,涵盖 composer.json 元信息配置、PSR-4 自动加载规则设置、命名空间规划、单元测试集成、README 与 LICENSE 编写规范,以及将包提交到 Packagist 公共仓库或搭建 Satis/Private Packagist 私有仓库的完整发布流程,帮助开发者将可复用代码封装为标准化的 Composer 包。

269

2026.04.10

Composer 自动加载机制与性能优化
Composer 自动加载机制与性能优化

系统剖析 Composer 的自动加载体系,讲解 PSR-0 与 PSR-4 自动加载标准的区别与演进、classmap 与 files 加载方式的适用场景、autoload_real.php 源码级加载流程解析,同时介绍 composer dump-autoload -o 优化加载映射、APCu 缓存加速、authoritative-classmap 配置等生产环境性能优化手段,帮助开发者深入理解自动加载原理并提升项目启动速度。

240

2026.04.13

Composer 在主流 PHP 框架中的应用实践
Composer 在主流 PHP 框架中的应用实践

结合 Laravel、ThinkPHP、Symfony 等主流 PHP 框架的实际场景,讲解 Composer 在框架项目中的典型应用,包括通过 create-project 初始化框架项目、安装与管理第三方扩展包、scripts 钩子(post-install/post-update)自动执行部署任务、自定义 Installer 插件开发、多项目共享 vendor 依赖的 Monorepo 工作流管理,帮助开发者在真实框架项目中充分发

323

2026.04.13

Composer 镜像源配置与网络问题排查
Composer 镜像源配置与网络问题排查

针对国内开发者常遇到的 Composer 网络问题,详细讲解阿里云、腾讯云、华为云等国内镜像源的全局与项目级切换方法、多镜像源优先级配置策略、composer config 命令行快速设置技巧,同时涵盖 SSL 证书错误、连接超时、下载中断等常见网络报错的排查与修复方案,以及利用 artifact / path 仓库实现完全离线环境下的依赖安装。

151

2026.04.14

Composer Scripts 脚本与自动化工作流
Composer Scripts 脚本与自动化工作流

系统讲解 Composer Scripts 机制的完整用法,涵盖 pre-install、post-update、post-autoload-dump 等内置事件钩子的触发时机与应用场景、自定义脚本命令的定义与参数传递、调用外部 Shell 命令与 PHP 静态方法、多脚本串联执行与条件判断,以及结合代码检查(PHPStan/PHP-CS-Fixer)、数据库迁移、缓存清理等任务构建一键部署自动化工作流。

210

2026.04.14

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

0

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
vscode手册
vscode手册

共0课时 | 0人学习

Git 教程
Git 教程

共21课时 | 7.8万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.8万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn