moodlehq/moodle-workplace-plugin-ci

moodle-plugin-ci GitLab运行镜像

镜像概述

本Docker镜像专为Workplace团队设计，用于在GitLab环境中运行moodle-plugin-ci工具。moodle-plugin-ci是Moodle插件开发中的关键工具，主要用于自动化测试、代码质量检查、风格验证等持续集成任务。该镜像预配置了运行moodle-plugin-ci所需的完整环境，旨在简化团队在GitLab CI/CD流程中集成Moodle插件自动化测试的过程。

核心功能与特性

核心功能

• 预配置环境：内置moodle-plugin-ci及其所有依赖，无需手动安装配置
• GitLab CI适配：针对GitLab CI/CD环境优化，可直接集成到GitLab流水线
• 自动化流程支持：支持Moodle插件的自动化测试、代码检查、风格验证等CI任务

主要特性

• 包含moodle-plugin-ci运行所需的全部依赖库与工具
• 已配置与GitLab Runner兼容的运行环境
• 减少CI流程中的环境配置时间，提升开发效率
• 确保团队内部使用统一的moodle-plugin-ci运行环境，避免环境差异导致的问题

使用场景与适用范围

使用场景

• Workplace团队开发Moodle插件时，通过GitLab CI/CD实现持续集成
• 在GitLab流水线中执行Moodle插件的自动化测试（单元测试、集成测试等）
• 对Moodle插件代码进行自动化质量检查、代码风格验证
• 集成到GitLab Merge Request流程，作为代码合并前的质量门禁

适用范围

• 仅限Workplace团队内部使用
• 适用于基于Moodle平台开发插件的项目
• 需在GitLab环境中运行，依赖GitLab CI/CD基础设施

使用方法与配置说明

前置条件

• 已部署GitLab环境及GitLab Runner
• 目标项目已托管在GitLab中，且需配置GitLab CI/CD

GitLab CI/CD配置示例

在项目的.gitlab-ci.yml文件中引用该镜像，示例如下：

yaml
stages:
  - test

moodle-plugin-test:
  stage: test
  image: [镜像名称]  # 替换为实际镜像名称/路径
  script:
    - moodle-plugin-ci install  # 安装Moodle及插件依赖
    - moodle-plugin-ci phplint  # 运行PHP代码检查
    - moodle-plugin-ci phpcs    # 运行代码风格检查
    - moodle-plugin-ci test     # 运行单元测试
  only:
    - branches
    - merge_requests

配置说明

• 镜像引用：在CI任务中通过image: [镜像名称]指定使用本镜像
• 核心命令：通过moodle-plugin-ci命令执行各类CI任务，具体命令可参考https://github.com/moodlehq/moodle-plugin-ci
• 环境变量：如需自定义配置，可通过GitLab CI/CD环境变量传递参数（具体支持的变量需参考团队内部文档）
• 依赖缓存：建议配置GitLab CI缓存机制，加速moodle-plugin-ci install步骤

注意事项

• 本镜像为Workplace团队内部专用，外部项目使用可能需要额外适配
• 确保GitLab Runner具备足够的资源（CPU、内存）以运行Moodle测试环境
• 定期更新镜像版本以获取最新的moodle-plugin-ci功能及安全补丁