Skip to main content

Canary リリース

Docusaurus は Canary リリース を採用しています。

これにより、リリース前の新機能は、Docusaurusの次期バージョンにプルリクエストがマージされ次第試用が可能となります。

Canary リリースを使うことは、動作確認を行い、メンテナーにフィードバックを与える良い方法です。

メモ

本番環境で Canary リリースを使うのはリスキーだと感じるかもしれませんが、実はそうでもありません。

Canary リリースはすべての自動化テストを通過しており、さらに Docusaurus のサイトの本番環境でも使用されているのです。

警告

以下に示す Canary バージョンは 最新ではない場合があります。 実際のバージョンは npm ページを参照してください。

Canary バージョンと npm のタグ​

main ブランチにおけるコードに関するコミットは、CI によって @canary タグの下で Canary リリースされます。 長くて10分程度かかります。

npm で現在のタグとそのバージョンを確認することができます

  • latest: 安定版 (現在は current)
  • canary: Canary リリース (現在は 例: 0.0.0-4922)
ヒント

必ず最新の Canary リリースを使用し、公開日を確認するようにしてください(公開プロセスが失敗することがあります)。

メモ

Canary バージョンの命名規則は 0.0.0-commitNumber です。

Canary リリースを使用する​

canary タグで公開されている最新バージョン (現在は 例: 0.0.0-4922) を参照します。

package.json 内の @docusaurus/* の依存すべてに同じバージョンを使用してください。

-  "@docusaurus/core": "^current",
-  "@docusaurus/preset-classic": "^current",
+  "@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/* パッケージを必ず含めてください。

Canary リリースを使用する場合、semver による範囲指定ではなく正確なバージョンを使用しましょう ( ^ プレフィックスは避けてください)。