SuperAPI AI 工具集

convex-deploy

部署与运维

查看项目

更新于 10-15 22:17

技能介绍

用途:为 Convex 项目建立部署流程、环境划分与 CI/CD 配置,涉及开发、生产、预览和本地部署,以及部署密钥和托管平台集成。

主要能力:核心命令包括 npx convex dev、npx convex deploy、npx convex codegen、npx convex run(生产用 --prod)。迭代时可用 CONVEX_AGENT_MODE=anonymous npx convex dev --once 安全生成 codegen 产物。部署目标解析:CONVEX_DEPLOY_KEY 存在时优先,否则使用 CONVEX_DEPLOYMENT 项目的生产部署。构建步骤:npx convex deploy --cmd "npm run build",必要时配合 --cmd-url-env-var-name。

使用方式:Vercel/Netlify 构建命令应使用 npx convex deploy --cmd 'npm run build',并须按环境设置 CONVEX_DEPLOY_KEY;预览种子数据通过 --preview-run 'functionName'。本地开发用 npx convex dev --local --once,但无公共 URL,HTTP 请求需代理(如 ngrok),Node actions 本地需 Node 18。自托管时先部署后端,前端托管他处;自定义域名需覆盖 CONVEX_CLOUD_URL 并重新部署,可选 CONVEX_SITE_URL。环境变量须按部署通过仪表盘或 npx convex env 设置。

适用场景:dev/prod/preview 部署、CI/CD、本地部署与托管平台集成。

限制:部署密钥不得提交或记录;生产部署密钥用于 CI,预览密钥按分支创建预览部署,开发密钥限定单一 dev 部署,管理员密钥完全控制。预览部署为测试功能,默认 5 天自动清理,名称绑定分支。Schema 必须匹配已有数据,部署会在校验失败时阻塞;安全变更包括加表、加可选字段后回填再改必填、用 v.union 放宽后回填再收窄。函数须保持向后兼容,计划函数须接受先前调度的参数。新索引在部署时回填可能拖慢生产推送,大表应使用分阶段索引;删除索引会同步删除。HTTP actions 用 https://<deployment>.convex.site,客户端用 https://<deployment>.convex.cloud,避免混用。