catalystsystem/gitlab-ci-php-base

gitlab-ci-php-base 镜像文档

镜像概述

gitlab-ci-php-base 是一个专为 GitLab CI/CD 流程设计的 PHP 基础镜像。该镜像基于官方 PHP 镜像构建，集成了 PHP 运行环境、常用扩展及 CI 工具，旨在简化 PHP 项目在 GitLab CI/CD 中的配置，提升自动化构建与测试效率。

核心功能与特性

• 基础 PHP 环境：提供标准 PHP 运行环境，支持 PHP 应用的基础执行需求。
• 常用扩展集成：预装 PHP 常用扩展（如 mbstring、json、xml、curl 等），满足多数 PHP 项目依赖。
• Composer 支持：内置 Composer 包管理器，可直接用于 PHP 项目依赖安装与管理。
• CI 流程适配：优化镜像体积，减少 CI/CD 流程中的拉取与启动时间，适配 GitLab Runner 执行环境。
• 兼容性：与官方 PHP 镜像接口兼容，支持基于此镜像扩展自定义配置。

使用场景

• GitLab CI 中的 PHP 项目构建：作为 CI 流程的基础镜像，执行 PHP 项目的依赖安装、代码编译等步骤。
• 单元测试执行：支持在 CI 中运行 PHPUnit 等测试框架，实现自动化单元测试。
• 代码质量检查：配合 PHPStan、PHPCS 等工具，在 CI 流程中进行代码静态分析与规范检查。
• 轻量级 PHP 环境需求：适用于需要快速启动 PHP 环境的临时任务或自动化脚本。

使用方法

基本使用（docker run）

通过 docker run 命令直接启动镜像，验证 PHP 环境：

bash
# 查看 PHP 版本
docker run --rm gitlab-ci-php-base php -v

# 运行 PHP 脚本
docker run --rm -v $(pwd):/app gitlab-ci-php-base php /app/script.php

# 使用 Composer 安装依赖
docker run --rm -v $(pwd):/app gitlab-ci-php-base composer install -d /app

GitLab CI 配置示例

在 GitLab 项目的 .gitlab-ci.yml 文件中使用该镜像，定义 CI 流程：

yaml
stages:
  - test
  - build

unit-test:
  stage: test
  image: gitlab-ci-php-base
  script:
    - composer install --no-dev
    - vendor/bin/phpunit tests/

code-quality:
  stage: test
  image: gitlab-ci-php-base
  script:
    - composer require --dev phpstan/phpstan
    - vendor/bin/phpstan analyze src/ --level=5

build-app:
  stage: build
  image: gitlab-ci-php-base
  script:
    - composer install --no-dev --optimize-autoloader
    - tar -czf app.tar.gz src/ vendor/
  artifacts:
    paths:
      - app.tar.gz

扩展与自定义配置

如需添加额外 PHP 扩展或工具，可基于该镜像构建自定义 Dockerfile：

dockerfile
FROM gitlab-ci-php-base

# 安装额外 PHP 扩展（以 redis 为例）
RUN docker-php-ext-install redis

# 安装额外工具（以 wget 为例）
RUN apt-get update && apt-get install -y wget && rm -rf /var/lib/apt/lists/*

构建并使用自定义镜像：

bash
docker build -t custom-gitlab-ci-php .
docker run --rm custom-gitlab-ci-php php -m | grep redis  # 验证扩展安装成功

注意事项

• 镜像默认不包含特定 PHP 版本信息，实际使用时需确认与项目兼容的 PHP 版本（可通过 GitLab 镜像仓库标签获取具体版本）。
• 敏感信息（如数据库凭证）建议通过 GitLab CI 环境变量传递，避免硬编码在镜像或配置文件中。
• 如需持久化数据或依赖缓存，可结合 GitLab CI 缓存机制（如缓存 vendor/ 目录）提升构建效率。