aligent/code-standards-pipe-php

Aligent Magento 代码标准管道

镜像概述和主要用途

Aligent Magento 代码标准管道是一个用于执行PHP代码标准检查的Docker镜像，主要适用于Magento项目。它能够集成到CI/CD流程中（如Bitbucket Pipelines和部分支持GitHub Actions），通过配置PHPCS标准对代码进行检查，同时确保安全检查始终运行，帮助开发团队维护代码质量。

核心功能和特性

• 支持指定PHPCS标准进行代码检查，安全检查将始终自动运行
• 可配置是否跳过项目Composer依赖安装，适配不同CI环境需求
• 提供调试模式，可输出额外调试信息
• 包含中间构建目标standards-runtime，适用于CLI工具和IDE集成
• 支持多PHP版本，可根据项目需求选择对应镜像标签

使用场景和适用范围

适用于Magento项目的代码质量管控流程，可在Bitbucket或GitHub的CI/CD流程中集成，在代码提交、拉取请求等阶段自动执行代码标准检查，确保代码符合项目规范和安全要求。

详细使用方法和配置说明

Bitbucket Pipelines 配置

在bitbucket-pipelines.yml文件中添加以下步骤：

yaml
      - step:
          name: "代码标准检查"
          script:
            - pipe: docker://aligent/code-standards-pipe-php:8.2
              variables:
                STANDARDS: "Magento2"
                SKIP_DEPENDENCIES: "true"
                MAGENTO_USER: "USER"
                MAGENTO_PASS: "PASS"

GitHub Actions 配置

该镜像对GitHub Actions有部分支持。需确保SKIP_DEPENDENCIES设置为true，且PHP版本与项目匹配。创建文件.github/workflows/phpcs.yml：

yaml
name: 运行PHP代码风格检查

on: pull_request
  
jobs:
  code-standards:
    runs-on: ubuntu-latest
    steps:
      - name: 检出代码
        uses: actions/checkout@v2
        with:
          fetch-depth: 0
      - name: 代码标准测试
        uses: docker://aligent/code-standards-pipe-php:8.1
        env:
          STANDARDS: "Magento2"
          SKIP_DEPENDENCIES: "true"

变量说明

本地使用

提供中间构建目标standards-runtime，该目标不包含Bitbucket特定的管道组件，本质上提供了PHPCS运行时环境，可用于CLI工具和IDE集成。

开发

本地调用

可通过以下命令在本地调用管道：

bash
docker run -v $PWD:/build --workdir=/build aligent/code-standards-pipe-php:<PHP_VERSION>

构建触发

• 推送到main分支的提交将触发针对各配置PHP版本的自动构建
• 推送到staging分支的提交将触发相同构建，但镜像标签会添加-experimental后缀