如何为你的Composer包配置自动化测试和代码覆盖率报告?(GitHub Actions)

16次阅读

在 GitHub Actions 中为 Composer 包配置自动化测试和覆盖率报告,核心是运行 PHPUnit 测试、生成 HTML 或 Clover 格式报告,并上传至 GitHub Artifacts 或 Coveralls;推荐使用 pcov(PHP 8 兼容)、shivammathur/setup-php 动作及条件化启用覆盖率。

如何为你的 Composer 包配置自动化测试和代码覆盖率报告?(GitHub Actions)

直接在 GitHub Actions 中为 Composer 包配置自动化测试和代码覆盖率报告,核心是三件事:用 phpunit 运行测试、生成覆盖率(推荐 phpcov 或 PHPUnit 原生 HTML 报告)、把结果上传到 GitHub 或存为产物。下面是最实用、开箱即用的配置方式。

确保项目已支持 PHPUnit 和覆盖率 工具

你的包必须有 phpunit.xml(或 phpunit.xml.dist),且已安装 PHPUnit(建议 9.5+ 或 10.x)和 php-coveralls / pcov / xdebug 之一。推荐优先用 pcov(轻量、快、PHP 8 兼容好):

  • composer.jsonrequire-dev 中加:"pcov/pcov": "^1.0"
  • 运行 composer install 后,确认 pcov 可用:php -m | grep pcov
  • PHPUnit 配置里启用覆盖率,例如在 phpunit.xml 中加入:

redFiles=”true”>
  
    php”>src/
  

GitHub Actions 工作流:测试 + 本地覆盖率报告

创建 .github/workflows/test.yml,使用官方 shivammathur/setup-php 动作可一键启用 pcov 并装好依赖:

  • 指定 PHP 版本(如 8.1、8.2、8.3)和扩展:extensions: [pcov]
  • 运行 composer installvendor/bin/phpunit --coverage-html=coverage
  • actions/upload-artifact 保存 coverage/ 目录,方便手动下载查看

这样每次 push 或 PR 都会生成可浏览的 HTML 覆盖率报告,放在 Actions 的“Artifacts”里点开就能看。

上传覆盖率到 Coveralls 或 Codecov(可选但推荐)

如果想长期追踪趋势、PR 中自动评论覆盖率变化,推荐接入 Coveralls(免费开源项目友好):

  • 安装 php-coveralls/php-coveralls(dev-only)
  • 在 workflow 中添加步骤:vendor/bin/php-coveralls --coverage_clover=build/logs/clover.xml
  • 确保 PHPUnit 生成 clover 格式:在 phpunit.xml 下加 <report><clover outputfile="build/logs/clover.xml"></clover></report>
  • Coveralls 会自动读取 GITHUB_TOKEN,无需额外密钥

跳过低版本 PHP 的覆盖率(避免失败)

PCOV 不支持 PHP

  • PHP 7.4–8.1:用 xdebug(加 coverage: xdebug 到 setup-php)
  • PHP 8.2+:用 pcov(加 extensions: [pcov]
  • PHP 7.3 及以下:跳过 --coverage-* 参数,只跑测试

可用 GitHub Actions 的 if 表达式控制,例如:if: matrix.php-version >= '7.4'

基本上就这些。不需要自建服务器、不用配 webhook,Composer 包开箱即得 CI/CD 级测试反馈和可视化覆盖率——关键是选对工具链(pcov + setup-php + Coveralls),再把配置写清楚。

以上就是如何为你的 Composer 包配置自动化测试和代码覆盖率报告?(GitHub Actions)的详细内容,更多请关注

星耀云
版权声明:本站原创文章,由 星耀云 2025-12-19发表,共计1563字。
转载说明:转载本网站任何内容,请按照转载方式正确书写本站原文地址。本站提供的一切软件、教程和内容信息仅限用于学习和研究目的;不得将上述内容用于商业或者非法用途,否则,一切后果请用户自负。本站信息来自网络,版权争议与本站无关。
text=ZqhQzanResources