金丝雀发布

Docusaurus 拥有一个金丝雀发布系统。

它允许您在 Docusaurus 的 下一个版本 的拉取请求合并后，立即测试新的未发布功能。

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

注意

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

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

警告

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

金丝雀 npm dist 标签

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

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

• latest：稳定版本（当前：3.5.2）
• canary：金丝雀版本（例如：0.0.0-4922）

提示

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

注意

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

使用金丝雀版本

获取在 canary npm dist 标签 下发布的最新版本（例如：0.0.0-4922）。

在您的 package.json 中将其用于所有 @docusaurus/* 依赖项

-  "@docusaurus/core": "^3.5.2",
-  "@docusaurus/preset-classic": "^3.5.2",
+  "@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

您还可以使用命令行升级 @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

警告

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

对于金丝雀版本，建议使用精确版本而不是语义版本范围（避免使用 ^ 前缀）。