金丝雀发布

Docusaurus 拥有金丝雀发布系统。

它允许你在拉取请求合并后立即测试新的未发布功能。

这是向维护者提供反馈、确保新实现功能按预期工作的好方法。

注意

在生产环境中使用金丝雀版本可能看起来有风险，但实际上并非如此。

金丝雀版本通过了所有自动化测试，并且Docusaurus站点本身也在生产环境中使用它。

警告

下面显示的金丝雀版本可能不是最新的。请访问npm 页面查找实际的版本名称。

金丝雀 npm dist 标签

对于main分支上的任何代码相关提交，持续集成系统都会在@canary npm dist 标签下发布金丝雀版本。这通常需要长达 10 分钟。

你可以在npm上查看当前的 dist 标签

• latest: 稳定版本 (当前: 3.8.1)
• canary: 金丝雀版本 (例如: 0.0.0-4922)

提示

请确保使用最新的金丝雀版本并检查发布日期（有时发布过程会失败）。

注意

金丝雀版本遵循0.0.0-commitNumber的命名约定。

使用金丝雀版本

使用金丝雀 npm dist 标签下发布的最新版本（例如: 0.0.0-4922）。

将此版本用于package.json中所有@docusaurus/*的依赖项

-  "@docusaurus/core": "^3.8.1",
-  "@docusaurus/preset-classic": "^3.8.1",
+  "@docusaurus/core": "0.0.0-4922",
+  "@docusaurus/preset-classic": "0.0.0-4922",

然后，重新安装依赖项并启动你的站点

npm

npm install
npm start

Yarn

yarn install
yarn start

pnpm

pnpm install
pnpm start

Bun

bun install
bun start

你也可以通过命令行升级@docusaurus/*包

npm

npm install --save-exact @docusaurus/core@canary @docusaurus/preset-classic@canary

Yarn

yarn add --exact @docusaurus/core@canary @docusaurus/preset-classic@canary

pnpm

pnpm add --save-exact @docusaurus/core@canary @docusaurus/preset-classic@canary

Bun

bun add --exact @docusaurus/core@canary @docusaurus/preset-classic@canary

警告

确保包含所有@docusaurus/*包。

对于金丝雀版本，首选使用精确版本而不是 semver 范围（避免使用^前缀）。