elegantthemes/gh-action-lint

docker-images

!latest

镜像概述和主要用途

docker-images是一个专注于代码质量自动化检查的Docker镜像，集成了PHPCS（PHP代码规范检查工具）和ESLint（JavaScript/TypeScript代码规范检查工具）。其核心功能是在代码变更时，仅针对修改文件的变更行执行代码规范检查，并将发现的错误以Pull Request（PR） Review评论的形式自动提交，帮助开发团队在代码审查阶段及时发现并修复规范问题，提升代码质量和团队协作效率。

核心功能和特性

• 多工具集成：同时支持PHPCS（PHP）和ESLint（JavaScript/TypeScript）两种主流代码规范检查工具
• 增量检查：仅对变更文件的修改行执行检查，避免全量检查带来的资源消耗和冗余结果
• PR评论集成：自动将检查到的错误以PR Review评论形式提交，直接关联到对应代码行，便于开发者定位和修复
• 轻量级部署：基于Docker容器化设计，可快速集成到各类CI/CD流程中，无需本地环境配置
• 版本跟踪：通过版本标签（如v3）明确标识功能迭代，便于版本管理和问题追溯

使用场景和适用范围

• 代码审查流程：适用于采用Git版本控制、通过PR进行代码提交和审查的开发团队
• 多语言项目：支持同时包含PHP和JavaScript/TypeScript代码的项目进行规范检查
• CI/CD集成：可嵌入GitHub Actions、GitLab CI、Jenkins等持续集成/持续部署流程，实现代码提交后的自动质量检查
• 团队协作：帮助团队统一代码规范执行标准，减少人工审查成本，提升审查效率

使用方法和配置说明

基本使用（Docker Run）

bash
docker run --rm \
  -e GITHUB_TOKEN="your_github_token" \
  -e REPO_PATH="owner/repo" \
  -e PR_NUMBER="123" \
  -v /path/to/your/code:/app \
  docker-images:v3

环境变量配置

Docker Compose配置示例

yaml
version: '3'
services:
  code-review-check:
    image: docker-images:v3
    environment:
      - GITHUB_TOKEN=your_github_token
      - REPO_PATH=owner/repo
      - PR_NUMBER=123
      - PHPCS_CONFIG=config/phpcs.xml
      - ESLINT_CONFIG=.eslintrc.js
    volumes:
      - ./your-code:/app

CI/CD集成示例（GitHub Actions）

在项目根目录创建.github/workflows/code-review-check.yml：

yaml
name: Code Review Check
on:
  pull_request:
    branches: [ main, develop ]

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v4
        with:
          fetch-depth: 0
      
      - name: Run code review check
        uses: docker://docker-images:v3
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
          REPO_PATH: ${{ github.repository }}
          PR_NUMBER: ${{ github.event.pull_request.number }}

注意事项

• 确保挂载的代码目录包含完整的版本控制信息（.git目录），以便工具识别变更文件
• GITHUB_TOKEN需具备足够权限，建议使用GitHub Actions内置的secrets.GITHUB_TOKEN（默认具备必要权限）
• 首次使用时建议先在本地测试配置，确保PHPCS和ESLint配置文件能被正确识别