Composer在GitHub Actions工作流中使用缓存加速构建的YAML(流水线)

夜辰大大_2771

夜辰大大_2771

2026-08-06

736人浏览

原创

不能缓存 vendor/ 目录,因其 autoloader 硬编码本地绝对路径,github actions 每次运行环境路径不同导致 require 失败;应只缓存 ~/.composer/cache,key 用 runner.os-php-版本-composer-lock 哈希组合。

composer在github actions工作流中使用缓存加速构建的yaml(流水线)

直接缓存 vendor/ 目录在 GitHub Actions 中几乎总是错的,会引发 Class not found 或 require(): failed to open stream 错误;正确做法是只缓存 ~/.composer/cache,并用 composer.lock 哈希 + PHP 版本构建 key。

为什么不能缓存 vendor/ 目录

Composer 生成的 autoloader(比如 vendor/composer/autoload_classmap.php)里硬编码了本地绝对路径。GitHub Actions 每次运行都在全新虚拟机上,路径(如 /home/runner/work/myapp/myapp)必然不同,旧缓存加载后直接报错——不是“没找到类”,而是“路径写死导致 require 失败”。
即使看起来能跑通,只要项目含 post-install-cmd 脚本、platform config 或扩展依赖,就可能因环境差异 silently fail。

正确的 cache key 构建方式

key 必须同时反映两个事实:依赖内容是否变更、PHP 运行时是否兼容。只靠 composer.lock 哈希不够,因为同一 lock 文件在 PHP 8.1 和 8.3 下可能安装不同 dist 分支或跳过不兼容包。

github-trending
github-trending

获取今日/本周/本月GitHub 热门仓库,并汇总前 15 名的星数、语言和描述。

下载
  • key: ${{ runner.os }}-php-${{ matrix.php-version }}-composer-${{ hashFiles('**/composer.lock') }}
  • hashFiles('**/composer.lock') 覆盖子目录(如 api/composer.lock),但若项目有多个 lock 文件,需拆成独立缓存步骤
  • 别用 ${{ runner.os }} 单独做后缀——Linux/macOS 下 ~/.composer/cache 结构一致,没必要区分
  • 绝对不要用 composer.json 的哈希,它不决定实际安装结果,composer.lock 才是唯一真相

workflow 中 cache action 的位置与参数

actions/cache@v4 必须放在 composer install 之前,且中间不能插入任何可能修改 ~/.composer/cache 的操作(比如提前运行 composer config)。

  • path: ~/.composer/cache —— 这是 Composer 默认缓存路径,别改成 ./cache 或 vendor/
  • restore-keys 推荐设为:${{ runner.os }}-php-${{ matrix.php-version }}-composer-,用于 lock 文件微调后的部分命中
  • 必须先执行 shivammathur/setup-php 或 actions/setup-php,否则 ~/.composer/cache 可能不存在或权限异常
  • composer install 参数推荐:--no-interaction --prefer-dist --optimize-autoloader,避免交互、优先用压缩包、生成高效 autoloader

多 PHP 版本矩阵下的典型配置片段

以下是从真实 CI 工作流中截取的最小可用结构,已剔除无关步骤:

- name: Checkout code
  uses: actions/checkout@v4
  • name: Setup PHP uses: shivammathur/setup-php@v2 with: php-version: ${{ matrix.php-version }} tools: composer

  • name: Cache Composer dependencies uses: actions/cache@v4 with: path: ~/.composer/cache key: ${{ runner.os }}-php-${{ matrix.php-version }}-composer-${{ hashFiles('**/composer.lock') }} restore-keys: | ${{ runner.os }}-php-${{ matrix.php-version }}-composer-

  • name: Install dependencies run: composer install --no-interaction --prefer-dist --optimize-autoloader

    注意:如果项目用 monorepo 结构且含多个 composer.lock,hashFiles('**/composer.lock') 会合并所有文件哈希——这通常是你想要的;但若各子包需隔离缓存,就得手动指定路径如 hashFiles('packages/foo/composer.lock') 并配多个 cache 步骤。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

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

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

2023.12.25

344

5

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

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

2026.04.10

563

36

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

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

2026.04.10

327

29

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

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

2026.04.10

349

15

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

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

2026.04.13

300

21

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

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

2026.04.13

463

14

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

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

2026.04.14

271

24

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

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

2026.04.14

330

18

Composer 私有仓库搭建与企业级管理
Composer 私有仓库搭建与企业级管理

面向团队与企业开发场景,讲解如何使用 Satis 搭建轻量级静态私有仓库、通过 Toran Proxy / Private Packagist 构建功能完善的企业级私有包管理平台,涵盖 Git/SVN 仓库类型接入、Token 鉴权与访问权限控制、Webhook 自动触发包更新、内网部署方案以及与 GitLab CI/CD 流水线的集成配置,帮助企业安全高效地管理内部 PHP 组件资产。

2026.04.14

380

26

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
phpMyAdmin 安装文档
phpMyAdmin 安装文档

共0课时 | 0人学习

phpEnv手册
phpEnv手册

共0课时 | 0人学习