From 81e6578fae4daf46bf1cf0188dc6198383146b65 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Thu, 5 Aug 2021 14:38:48 +0200 Subject: [PATCH] docs: update canary doc (#5296) --- website/community/4-canary.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/website/community/4-canary.md b/website/community/4-canary.md index ca8d9d5488..c84f647690 100644 --- a/website/community/4-canary.md +++ b/website/community/4-canary.md @@ -21,7 +21,7 @@ For any code-related commit on `master`, the continuous integration will publish You can see on [npm](https://www.npmjs.com/package/@docusaurus/core?activeTab=versions) the current dist tags: - `latest`: stable releases (example: `2.0.0-beta.0`) -- `canary`: canary releases (example: `2.0.0-beta.0.1234.4a6de5cf7`) +- `canary`: canary releases (example: `0.0.0-1234+4a6de5cf7`) :::tip @@ -29,17 +29,23 @@ Make sure to use the latest canary release and check the publication date (somet ::: +:::note + +Canary versions follow the naming convention `0.0.0-commitNumber+commitHash`. + +::: + ## Using a canary release -Take the latest version published under the [canary npm dist tag](https://www.npmjs.com/package/@docusaurus/core?activeTab=versions) (for example: `2.0.0-beta.0.1234.4a6de5cf7`). +Take the latest version published under the [canary npm dist tag](https://www.npmjs.com/package/@docusaurus/core?activeTab=versions) (for example: `0.0.0-1234+4a6de5cf7`). Use it for all the `@docusaurus/*` dependencies in your `package.json`: ```diff - "@docusaurus/core": "^2.0.0-beta.0", - "@docusaurus/preset-classic": "^2.0.0-beta.0", -+ "@docusaurus/core": "2.0.0-beta.0.1234.4a6de5cf7", -+ "@docusaurus/preset-classic": "2.0.0-beta.0.1234.4a6de5cf7", ++ "@docusaurus/core": "0.0.0-1234+4a6de5cf7", ++ "@docusaurus/preset-classic": "0.0.0-1234+4a6de5cf7", ``` Then, install the dependencies again and start your site: @@ -55,12 +61,6 @@ You can also upgrade the `@docusaurus/*` packages with a command line: npm install --save-exact @docusaurus/core@canary @docusaurus/preset-classic@canary ``` -:::note - -Canary versions follow the naming convention `lastestRelease.commitNumber.commitHash`. - -::: - :::caution Make sure to include all the `@docusaurus/*` packages.