oskarstark/phpstan-ga

oskarstark/phpstan-ga Docker镜像文档

镜像概述和主要用途

oskarstark/phpstan-ga是一个专为GitHub Actions设计的Docker镜像，用于集成PHPStan静态代码分析工具。它允许PHP项目在GitHub Actions工作流中自动化执行代码质量检查，帮助开发团队及早发现代码中的潜在错误和不一致性。

核心功能和特性

• GitHub Actions集成：可直接在GitHub Actions工作流中配置使用，无需额外安装PHPStan环境
• 自定义分析参数：支持通过命令行参数指定分析目录、分析级别等
• 依赖管理：可选择安装项目的开发依赖，确保分析环境一致性
• 平台检查控制：支持跳过PHP平台需求检查，提高兼容性
• 配置文件支持：自动识别项目根目录的phpstan.neon.dist配置文件
• 本地运行支持：提供Docker镜像，可在本地环境直接运行进行代码分析

使用场景和适用范围

适用于所有需要在GitHub Actions工作流中实现PHP代码自动化静态分析的项目，特别适合：

• PHP开发团队的CI/CD流程集成
• 需要自动化代码质量检查的项目
• 希望标准化代码分析流程的团队
• 需要在本地和CI环境保持一致分析结果的场景

使用方法和配置说明

GitHub Action使用

基本配置

在GitHub仓库的.github/workflows/目录下创建工作流文件（如test.yml），添加以下配置：

yaml
# .github/workflows/test.yml 

on:
  push:
    branches:
      - master
  pull_request:

name: Test

jobs:
  phpstan:
    name: PHPStan

    runs-on: ubuntu-latest

    steps:
    - name: "Checkout"
      uses: actions/checkout@v2

    - name: PHPStan
      uses: docker://oskarstark/phpstan-ga
      with:
        args: analyse src/

使用特定级别

通过args参数指定PHPStan分析级别：

diff
      uses: docker://oskarstark/phpstan-ga
      with:
-        args: analyse src/
+        args: analyse src/ --level=5

安装开发依赖

如需安装项目的开发依赖，添加REQUIRE_DEV环境变量：

diff
      uses: docker://oskarstark/phpstan-ga
+     env:
+       REQUIRE_DEV: true
      with:
        args: analyse src/

跳过平台需求检查

如需跳过PHP平台需求检查，添加CHECK_PLATFORM_REQUIREMENTS环境变量：

diff
      uses: docker://oskarstark/phpstan-ga
+     env:
+        CHECK_PLATFORM_REQUIREMENTS: false
      with:
        args: analyse src/

使用配置文件

在项目根目录放置phpstan.neon.dist配置文件，镜像会自动识别并应用该配置。

快速启动

可直接复制示例中的.github文件夹（位于镜像仓库的examples/目录下）到项目根目录，即可快速启用PHPStan代码分析工作流。

Docker本地运行

镜像地址

Docker镜像已自动构建并托管于Docker Hub：
https://hub.docker.com/r/oskarstark/phpstan-ga

本地运行命令

可在任意目录下运行以下命令执行PHPStan分析：

bash
docker run --rm -it -w=/app -v ${PWD}:/app oskarstark/phpstan-ga:latest analyse src/ --level=5

参数说明：

• --rm：容器退出后自动删除
• -it：交互式终端
• -w=/app：设置工作目录为/app
• -v ${PWD}:/app：将当前目录挂载到容器的/app目录
• analyse src/ --level=5：PHPStan分析命令，指定分析目录和级别