3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-07-30 06:50:36 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: update canary doc (#5296)

Browse source
This commit is contained in:
Sébastien Lorber 2021-08-05 14:38:48 +02:00 • committed by GitHub
parent b5ecf270d9
commit 81e6578fae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

20
website/community/4-canary.md
View file

@ -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: 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`) - `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 :::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 ## 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`: Use it for all the `@docusaurus/*` dependencies in your `package.json`:
```diff ```diff
- "@docusaurus/core": "^2.0.0-beta.0", - "@docusaurus/core": "^2.0.0-beta.0",
- "@docusaurus/preset-classic": "^2.0.0-beta.0", - "@docusaurus/preset-classic": "^2.0.0-beta.0",
+ "@docusaurus/core": "2.0.0-beta.0.1234.4a6de5cf7", + "@docusaurus/core": "0.0.0-1234+4a6de5cf7",
+ "@docusaurus/preset-classic": "2.0.0-beta.0.1234.4a6de5cf7", + "@docusaurus/preset-classic": "0.0.0-1234+4a6de5cf7",
``` ```
Then, install the dependencies again and start your site: 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 npm install --save-exact @docusaurus/core@canary @docusaurus/preset-classic@canary
``` ```
:::note
Canary versions follow the naming convention `lastestRelease.commitNumber.commitHash`.
:::
:::caution :::caution
Make sure to include all the `@docusaurus/*` packages. Make sure to include all the `@docusaurus/*` packages.