plone/volto-addon-ci

Volto插件测试Docker镜像

!Docker Cloud Build Status

优化用于运行Volto插件测试的Docker镜像。

支持的标签及对应Dockerfile链接

• https://hub.docker.com/r/plone/volto-addon-ci/tags/

基础Docker镜像

• https://hub.docker.com/r/plone/volto-addon-ci/

源代码

• http://github.com/plone/volto-addon-ci

镜像概述和主要用途

该镜像专为Volto插件的持续集成流程设计，提供了一站式测试环境，支持多种代码质量检查和测试工具，可简化Volto插件的自动化测试流程。

核心功能和特性

• 支持多种测试命令：单元测试、代码风格检查、格式化检查等
• 灵活的环境变量配置，适配不同测试场景
• 支持远程Git仓库和本地代码测试
• 内置Volto项目环境，无需手动配置依赖

使用场景和适用范围

• Volto插件开发过程中的本地测试
• 持续集成/持续部署(CI/CD)流程中的自动化测试
• 代码质量检查和风格统一验证
• 插件兼容性测试

使用方法和配置说明

简单使用

bash
$ docker run -it --rm \
             -e GIT_NAME=volto-group-block \
             -e GIT_BRANCH=develop \
             -e NAMESPACE=@eeacms \
             -e DEPENDENCIES="@eeacms/volto-blocks-form" \
         plone/volto-addon-ci eslint

高级使用

bash
$ docker run -it --rm \
             -e GIT_NAME=volto-group-block \
             -e GIT_CHANGE_ID=50 \
             -e GIT_BRANCH=PR-50 \
             -e NAMESPACE=@eeacms \
             -e DEPENDENCIES="@eeacms/volto-blocks-form" \
         plone/volto-addon-ci eslint

本地使用

bash
$ cd src/addons/volto-slate

$ docker run -it --rm \
             -v $(pwd):/opt/frontend/my-volto-project/src/addons/volto-slate \
             -e GIT_NAME=volto-slate \
         plone/volto-addon-ci

支持的环境变量

• VOLTO：项目使用的Volto版本，默认使用最新发布版本
• TIMEOUT：超时时间(毫秒)，例如TIMEOUT=60000，默认120000
• GIT_NAME：Git仓库名称，例如GIT_NAME=volto-group-block，必填
• GIT_URL：Git仓库根URL，例如GIT_URL=https://gitlab.com，默认https://github.com
• GIT_BRANCH：测试的Git分支，例如GIT_BRANCH=develop，默认master
• GIT_USER：Git用户覆盖，例如GIT_USER=collective，默认eea
• GIT_CHANGE_ID：GitHub拉取请求ID，例如GIT_CHANGE_ID=PR-5，默认未设置
• NAMESPACE：Volto插件命名空间，例如NAMESPACE=@eeacms，默认未设置
• DEPENDENCIES：Volto插件依赖(空格分隔)，例如DEPENDENCIES=@eeacms/volto-blocks-form volto-slate，默认未设置
• RAZZLE_API_PATH：Razzle API路径，例如RAZZLE_API_PATH=http://foo.bar:8080/plone，默认http://plone:8080/Plone
• CYPRESS_API_PATH：Cypress API路径，默认使用$RAZZLE_API_PATH

支持的命令

• test：运行jest Volto插件单元测试（默认命令）
• eslint：对Volto插件代码运行eslint检查
• stylelint：对Volto插件代码运行stylelint检查
• prettier：对Volto插件代码运行prettier检查
• cypress：此字段对Volto插件代码运行cypress检查

版权和许可

原始代码的初始所有者是欧洲环境署(EEA)。保留所有权利。

原始代码是自由软件；您可以根据自由软件基金会发布的GNU通用公共许可证的条款重新分发和/或修改它；可以是版本2，也可以是(可选)任何更高版本。

资金支持

欧洲环境署(EU)