一个 Nimbus 版本包含两部分:@cloudflare/nimbus-docs 包,像普通依赖一样升级;以及起始模板和注册表文件的变更,它们位于你的仓库中,只有你采纳时才会改变。本页介绍这两部分,nimbus-docs migrate 会列出你的版本跳跃所需的每个步骤。所有权解释了它们为什么分开。
先提交你的工作,这样升级做出的每项改动都会显示在 git diff 中。
-
更新包
npm i @cloudflare/nimbus-docs@latest yarn add @cloudflare/nimbus-docs@latest pnpm add @cloudflare/nimbus-docs@latest bun add @cloudflare/nimbus-docs@latest -
运行迁移
npx @cloudflare/nimbus-docs migrate yarn nimbus-docs migrate pnpm nimbus-docs migrate bunx @cloudflare/nimbus-docs migratemigrate会比较你的站点上次审查的版本(记录在nimbus.json中)与你安装的版本。它会列出:- 迁移项:可以应用到你的代码,例如重命名的选项。写入前会询问;
--dry-run和--diff只展示计划而不写入。 - 必需的升级审查:你必须手动完成的变更,每项都包含受影响的文件、要做什么以及如何检查。
- 可选的升级条目:你现在或以后可以采纳的改进,例如重新设计的组件。
逐项完成必需的审查。然后运行
migrate最后打印的命令migrate --yes,把新版本记录到nimbus.json。如果nimbus.json没有说明你来自哪个版本,请传入:migrate --from 0.17.0。 - 迁移项:可以应用到你的代码,例如重命名的选项。写入前会询问;
-
采纳起始模板变更
npx @cloudflare/nimbus-docs outdated yarn nimbus-docs outdated pnpm nimbus-docs outdated bunx @cloudflare/nimbus-docs outdatedoutdated会列出起始模板文件(例如布局和globals.css)自你的站点创建以来在上游发生的变更。对于未编辑过的文件,采纳新版本:npx @cloudflare/nimbus-docs diff src/layouts/DocsLayout.astro --apply yarn nimbus-docs diff src/layouts/DocsLayout.astro --apply pnpm nimbus-docs diff src/layouts/DocsLayout.astro --apply bunx @cloudflare/nimbus-docs diff src/layouts/DocsLayout.astro --apply对于编辑过的文件,运行不带
--apply的diff查看两组变更,然后手动合并。 -
采纳注册表变更
对于通过
nimbus-docs add安装的组件,重新安装outdated列出的那些:npx @cloudflare/nimbus-docs add api-layout --overwrite yarn nimbus-docs add api-layout --overwrite pnpm nimbus-docs add api-layout --overwrite bunx @cloudflare/nimbus-docs add api-layout --overwrite--overwrite会替换未编辑的文件,并对编辑过的文件询问。没有终端时,它会保留编辑过的文件并列出它们。
验证
npx @cloudflare/nimbus-docs check
yarn nimbus-docs check
pnpm nimbus-docs check
bunx @cloudflare/nimbus-docs checknpm run build
yarn run build
pnpm run build
bun run buildcheck 无错误退出,构建通过,并且 outdated 不列出必需的包 API 工作。浏览站点,然后提交。
如果出问题
- 命名了重命名选项或已移除辅助函数的构建错误通常有对应迁移:再次运行
migrate并阅读输出。 - 来自你拥有的文件(例如布局)的错误,意味着它需要上游变更:用
diff <file>比较。
各包的变更日志(位于 npm 和仓库中)列出了每个版本的变化。