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

如何在 Composer 脚本中获取当前的分支名或 Git commit 信息?

冬宇同学_4330

冬宇同学_4330

发布时间:2025-12-13 17:33:20

|

664人浏览过

|

来源于php中文网

原创

Composer脚本中需用shell_exec调用git命令获取分支名、commit信息等,如git rev-parse --abbrev-ref HEAD,并写入VERSION.json;须确保环境有Git且在仓库根目录,加容错处理。

如何在 composer 脚本中获取当前的分支名或 git commit 信息?

在 Composer 脚本中直接获取 Git 分支名或 commit 信息,不能靠 Composer 自身提供,得借助系统命令(如 git)在脚本执行时动态读取。关键在于确保运行环境有 Git 可用,且项目是 Git 仓库。

使用 exec 在脚本中调用 Git 命令

Composer 的 scripts 支持 shell 命令,可用 exec() 或 shell_exec() 执行 Git 命令并捕获输出。推荐在自定义 PHP 脚本中操作,更可控:

  • 获取当前分支名:git rev-parse --abbrev-ref HEAD
  • 获取完整 commit hash:git rev-parse HEAD
  • 获取短 commit hash:git rev-parse --short HEAD
  • 检查是否干净工作区:git status --porcelain(输出为空表示干净)

在 composer.json 中定义脚本并调用 PHP 处理器

先在 composer.json 里注册一个脚本,指向你的 PHP 文件:

"scripts": {
  "post-install-cmd": [
    "MyBuildScript::injectGitInfo"
  ]
}

然后创建 MyBuildScript.php(确保自动加载或 require 进来),内容类似:

Json Repair Kit
Json Repair Kit

使用 Node.js 评估修复格式错误的 JSON,自动纠正尾随逗号、单引号、未加引号的键等常见问题,实现文件规范化。

下载
class MyBuildScript
{
    public static function injectGitInfo($event)
    {
        $branch = trim(@shell_exec('git rev-parse --abbrev-ref HEAD 2>/dev/null'));
        $commit = trim(@shell_exec('git rev-parse --short HEAD 2>/dev/null'));
        $dirty = !empty(trim(@shell_exec('git status --porcelain 2>/dev/null')));

        $info = [
            'branch' => $branch ?: 'unknown',
            'commit' => $commit ?: 'unknown',
            'dirty'  => $dirty,
        ];

        file_put_contents('VERSION.json', json_encode($info, JSON_PRETTY_PRINT));
    }
}

注意权限与环境限制

某些部署环境(如 CI/CD 的精简镜像、Docker 容器)可能没装 Git,或工作目录不是 Git 仓库根目录:

  • 加 2>/dev/null 避免错误输出干扰
  • 用 @shell_exec 抑制警告(但建议先判断 git --version 是否可用)
  • 确保脚本在项目根目录运行(Composer 默认满足,但自定义命令需留意 getcwd())
  • 若用于生产构建,建议把 Git 信息写入文件或常量,避免运行时依赖

替代方案:构建前生成静态元数据

更健壮的做法是在 CI 流程中提前生成版本信息(如用 git describe),再注入到 Composer 构建上下文:

  • CI 脚本中运行:echo "APP_VERSION=$(git describe --tags --always --dirty)" >> .env
  • PHP 中用 $_ENV 或 getenv() 读取,不依赖运行时 Git
  • 或生成 build-info.php,被项目直接 require

基本上就这些。核心是别指望 Composer 内置 Git 支持,老老实实用 shell 命令,加好容错就行。

热门AI工具

更多
SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

墨刀AI
墨刀AI Hot

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

超级麦吉

一款通过数字员工协作完成调研、数据分析与文档制作的AI办公平台。

WorkBuddy

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

豆包大模型

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

Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

DeepSeek

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

超级简历WonderCV

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

相关专题

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

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

344

2023.12.25

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

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

583

2026.04.10

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

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

347

2026.04.10

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

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

369

2026.04.10

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

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

320

2026.04.13

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

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

503

2026.04.13

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

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

291

2026.04.14

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

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

350

2026.04.14

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

100

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
墨刀帮助中心
墨刀帮助中心

共0课时 | 0人学习

MyEclipse学习中心
MyEclipse学习中心

共0课时 | 0人学习

Apache Subversion 官方手册
Apache Subversion 官方手册

共0课时 | 0人学习

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

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