ContextQMD
Back to Nocobase

版本控制

docs/docs/cn/ai-builder/version-control.md

2.1.194.6 KB
Original Source

版本控制

:::tip 前置条件

  • 阅读本页前，请确保你已按照 AI 搭建快速开始 安装了 NocoBase CLI 并完成了初始化
  • 需要启用「备份管理」和「版本控制」两个插件
  • 社区版和标准版不包含版本控制插件。如果只是想在关键变更前保留可回退状态，可以使用 备份管理

:::

简介

版本控制 Skill（nocobase-revision）用于在 AI 搭建完成一个有意义的阶段性成果后，创建一份可恢复的应用版本。比如搭好一个页面、创建一组数据表，或者配置完一条工作流后，AI 可以通过 nb revision create 保存当前状态。

它不是每改一个字段就创建一次版本。默认只在完成并验证一个清晰节点后保存，这样版本列表更容易读，恢复时也更容易判断该回到哪里。

如果你想了解版本列表、手动创建版本、恢复版本和保留策略，请参阅 版本控制插件操作手册。

能力范围

可以做：

  • 在完成并验证一个搭建节点后创建版本
  • 为版本写入简短描述，说明这次保存对应的成果
  • 使用当前 CLI 环境创建版本

不能做：

  • 不能替代备份管理插件的底层保存和恢复能力
  • 不能在版本控制插件未启用时创建版本
  • 不能自动恢复到某个版本，恢复操作请在 版本控制插件 中完成

提示词示例

场景 A：保存刚完成的页面配置

text
保存当前搭建成果为版本：完成客户管理页面、筛选区和编辑表单配置

Skill 会把描述整理成一段简短的版本说明，然后创建版本。

命令行模式：

bash
nb revision create "完成客户管理页面、筛选区和编辑表单配置"

场景 B：保存数据模型和工作流节点

text
刚才的供应商数据表和采购审批工作流已经验证通过，帮我创建一个版本

适合在跨多个能力的搭建完成后使用。比如先用 数据建模 创建数据表，再用 工作流管理 配置审批流程，验证通过后再保存版本。

场景 C：在指定环境创建版本

text
在 dev 环境保存一个版本：完成工单管理页面和 SLA 字段配置

如果指定的环境不是当前 CLI 环境，Skill 会先确认目标环境，避免把版本保存到错误的应用里。

命令行模式：

bash
nb revision create --env dev --yes "完成工单管理页面和 SLA 字段配置"

版本描述怎么写

版本描述应该说明“已经完成了什么”，而不是只写一个空泛标签。

推荐写法：

  • 完成客户台账、详情页与审批提交流程配置
  • 完成供应商数据表、采购申请表单和审批工作流
  • Completed customer detail page, edit form, and submission workflow wiring

不推荐写法：

  • snapshot
  • backup
  • test
  • version 2
  • 只有日期或时间戳

另外，不要在描述里写入 Token、地址、密码或其他敏感信息。描述会出现在版本列表里，应该保持清晰、可读、可审计。

常见问题

什么时候应该创建版本？

默认在一个可独立确认的节点完成后创建。比如一个页面已经能打开并正常编辑，一组数据表关系已经验证通过，或者一条工作流已经保存并检查过节点链。

为什么不是每次 AI 调整后都创建版本？

太细的版本会让列表很快变得难以判断。通常来说，一个版本应该对应一个“可以回退到这里继续工作”的节点，而不是一次字段重命名或一次按钮位置调整。

创建版本前需要验证吗？

需要。版本控制 Skill 只适合保存已经完成并验证过的成果。如果页面还报错、工作流还没确认，建议先让 AI 修复并验证，再创建版本。

创建后在哪里恢复？

在「版本控制」插件的版本列表里恢复。恢复会覆盖当前应用配置和该版本中包含的数据内容，操作前建议先阅读 版本控制插件操作手册。

相关链接