yappabe/php-ci

Yappa PHP CI镜像

!Docker pulls

镜像概述和主要用途

Yappa PHP CI镜像是一个专为PHP项目持续集成流程设计的Docker镜像，集成了多种常用的PHP开发和质量保障工具。该镜像旨在简化PHP项目的CI/CD流程，提供一站式的代码质量检查、单元测试执行和文档生成能力。

核心功能和特性

镜像包含以下工具：

• phpDocumentor：PHP代码文档生成工具
• phpcpd：PHP代码重复检测工具
• phpunit：PHP单元测试框架
• phpmd：PHP代码混乱度检测工具
• pdepend：PHP依赖分析工具
• phpcs：PHP代码规范检查工具
• phpcbf：PHP代码规范自动修复工具
• phpcb：PHP代码浏览器工具
• phpuni：PHP单元测试辅助工具
• php-cs-fixer：PHP代码风格修复工具

使用场景和适用范围

适用于各类PHP项目的持续集成流程，包括但不限于：

• 代码提交前的本地质量检查
• CI/CD管道中的自动化测试环节
• 代码质量报告生成
• 项目文档自动构建
• 代码风格统一和规范检查

使用方法和配置说明

基本使用方式

通过Docker命令直接运行镜像，挂载项目目录并执行所需工具：

bash
# 运行phpunit测试
docker run --rm -v $(pwd):/app yappabe/php-ci phpunit /app/tests

# 执行phpcs代码规范检查
docker run --rm -v $(pwd):/app yappabe/php-ci phpcs /app/src

# 生成phpDocumentor文档
docker run --rm -v $(pwd):/app yappabe/php-ci phpDocumentor run -d /app/src -t /app/docs

在CI流程中使用

可集成到GitLab CI、GitHub Actions等CI系统中，示例.gitlab-ci.yml配置：

yaml
stages:
  - test
  - quality

unit_test:
  stage: test
  image: yappabe/php-ci
  script:
    - phpunit tests/

code_quality:
  stage: quality
  image: yappabe/php-ci
  script:
    - phpcs --standard=PSR2 src/
    - phpmd src/ text cleancode,codesize,controversial,design,naming,unusedcode

工具参数说明

各工具的具体使用参数可参考其官方文档，镜像中工具的调用方式与原生环境一致，直接通过命令行参数进行配置。