メインコンテンツにスキップ

カナリアリリース

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という命名規則に従います。

カナリアリリースの使用​

カナリア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 install
npm start

コマンドラインで@docusaurus/*パッケージをアップグレードすることもできます

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

すべての@docusaurus/*パッケージが含まれていることを確認してください。

カナリアリリースでは、semver範囲の代わりに正確なバージョンを使用してください（^プレフィックスは避けてください）。