提交PR前先测试!用CapRover One Click Apps仪表盘的TEMPLATE功能快速验证你的应用

发布时间:2026/8/24 10:34:50
提交PR前先测试!用CapRover One Click Apps仪表盘的TEMPLATE功能快速验证你的应用 提交PR前先测试用CapRover One Click Apps仪表盘的TEMPLATE功能快速验证你的应用【免费下载链接】one-click-appsCommunity Maintained One Click Apps (https://github.com/caprover/caprover)项目地址: https://gitcode.com/gh_mirrors/on/one-click-apps为 CapRover 的 One Click Apps 仓库贡献应用时最高效的习惯是先测试、再提交PR。利用 CapRover 仪表盘中隐藏的TEMPLATE功能你可以把刚写好的 YAML 一键粘贴运行在代码评审之前就能看到应用真实的部署效果避免PR被打回的尴尬。为什么提交PR前一定要先测试One Click App 本质上是一个带变量替换规则的 Docker Compose 模板。YAML 语法正确 ≠ 部署成功端口映射、依赖服务、环境变量、数据库初始化……任何一环出错用户安装时都会遇到 502 或启动失败。官方在 README.md 中明确要求创建好 yaml 文件后必须先在本地 CapRover 上测试然后再提交 Pull Request。TEMPLATE功能是什么TEMPLATE 是 CapRover 官方为社区贡献者预留的草稿箱入口。官方仓库即本仓库public/v4/apps/目录下的所有应用由专门的构建脚本 scripts/build_one_click_apps_from_v4.js 统一打包发布个人无法直接上线——但 TEMPLATE 让你不修改仓库就能完整走一遍用户安装的流程表单变量是否正确渲染、正则校验是否生效各服务是否按depends_on顺序正常启动访问地址、默认端口、数据库连通性是否符合预期TEMPLATE功能最快验证步骤5步走按照 README.md 中的官方测试指引操作登录你自己的 CapRover 仪表盘dashboard进入apps页面点击One-Click Apps/Databases在下拉列表的最底部选择 TEMPLATE 把你的 YAML 完整粘贴进文本框点击NEXT逐项填写变量值观察应用是否按预期部署和访问✅ 部署成功后务必点进应用确认真实可访问而不只是容器显示 running。YAML 编写要点速查粘贴到 TEMPLATE 前先对照仓库里的标杆示例 public/v4/apps/privatebin.yml 自查几项硬性要求检查项说明captainVersion: 4必须写在 YAML 文件第一行caproverOneClickApp区块必填含displayName、description、instructionsdescription长度不超过 200 字符否则会被校验脚本直接拒绝instructions.start/end安装前说明和部署完成提示均不可缺省内置变量可复用$$cap_appname、$$cap_root_domain、$$cap_gen_random_hex(长度)应用图标必须同步提交到public/v4/logos/文件名与 yml 一致多服务应用如 WordPress MySQL可参考 public/v4/apps/wordpress.yml数据库服务记得设置caproverExtra中的notExposeAsWebApp: true避免暴露出多余的 Web 入口。TEMPLATE验证通过后提交PR前的本地三连本地跑一遍官方脚本能提前拦截绝大多数低级错误命令定义见 package.jsonnpm run validate_apps执行 scripts/validate_apps.js逐文件检查版本号、必填字段、description 长度并确认对应 logo 文件存在npm run formatter-write用 Prettier 统一所有 yml/json 的格式避免CI风格报错npm run build完整构建一遍产物模拟仓库发布流程三步全部无报错后你的PR基本就能一次性通过评审。常见踩坑清单latest标签校验脚本虽未强制但官方不建议使用请固定具体版本变量未加正则validRegex不设置时字段允许为空生产场景请补上logo 文件名不匹配adminer.yml必须配adminer.png大小写敏感忘测多行变量description里的长链接、instructions里的换行符粘贴到 TEMPLATE 后都要实测渲染效果先花 5 分钟跑一次 TEMPLATE能省掉来回三轮的评审沟通时间——这就是社区维护 CapRover One Click Apps 最顺滑的贡献姿势。【免费下载链接】one-click-appsCommunity Maintained One Click Apps (https://github.com/caprover/caprover)项目地址: https://gitcode.com/gh_mirrors/on/one-click-apps创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考