Hygraph 模式迁移自动化 SDK
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_3c6cb52e/hygraph-management-sdk-schema-migration-automation。
技能介绍
解决的问题
在 Hygraph 项目中,schema 变更往往散落在控制台的手工操作里:新增字段、调整模型全靠人工点击。这类操作无法复现、没有版本记录,也很难在 CI 流水线中预知某次改动的影响。当 Agent 工作流需要按固定节奏执行内容模型调整时,手工方式很快会失控。
技能如何工作
这个技能封装了 @hygraph/management-sdk,把 schema 管理变成代码优先(code-first)的迁移流程:
- 通过
newMigration({ endpoint, authToken })连接指定的 Hygraph 环境,天然支持按环境执行不同的 schema 更新; - 用迁移对象提供的方法(如
createModel)声明式地定义模型与字段变更,而不是手写请求体; - 支持 dry-run 预览:在应用迁移前先查看它将产生的改动,适合放进自动化流程做安全校验;
- 迁移以代码形式沉淀在仓库中,同一组变更可重复执行、结果一致,便于审查和协作。
适用边界与注意点
- 运行环境需要 Node.js,并必须提供 Hygraph auth token 与目标环境的 endpoint;
- 若扩展了 schema 类型定义,必须重新执行
npm run generate,同步 SDK 所依赖的 Management API schema; - 该技能是对上游 SDK 的封装,字段类型与迁移语义以官方文档为准(https://hygraph.com/docs/api-reference/developer-tools/management-sdk)。
使用场景
- 在CI流水线中执行内容模型变更前,使用dry-run预览迁移影响并生成可审查的审计记录。
- 多环境(开发/测试/生产)需要同步schema更新时,通过指定endpoint和authToken确保变更可追溯且符合环境要求。
- Agent工作流需要按固定节奏自动调整内容模型时,通过代码声明式迁移避免手工操作的不可控性。
- 当schema类型定义扩展后,需要重新生成SDK依赖的Management API schema时执行npm run generate。
适合人员
- 后端工程师:需要在CI/CD流程中自动化管理Hygraph项目schema,避免手动操作导致的错误和不可复现问题。
- DevOps负责人:负责多环境schema同步,需要可重复的迁移流程和审计记录。
- Agent开发者:构建需要按节奏调整内容模型的工作流,依赖代码优先的迁移方法确保一致性。