15308555518/ docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-12-26 01:33:02 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix: fix canary release versions (#5285)

This commit is contained in:
Sébastien Lorber 2021-08-04 18:34:06 +02:00 committed by GitHub
parent c603056f66
commit 33b88ab717
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
package.json
View File

@ -32,7 +32,8 @@
"crowdin:upload:v2": "crowdin upload sources --config ./crowdin-v2.yaml",
"crowdin:download:v2": "crowdin download --config ./crowdin-v2.yaml",
"canary": "yarn canary:bumpVersion && yarn canary:publish",
"canary:bumpVersion": "yarn lerna version 2.0.0-beta.`git rev-parse --short HEAD` --exact --no-push --yes",
"canary:version": "echo `node -e \"console.log(require('./packages/docusaurus/package.json').version)\"`.`git rev-list --count HEAD`.`git rev-parse --short HEAD`",
"canary:bumpVersion": "yarn lerna version `yarn --silent canary:version` --exact --no-push --yes",
"canary:publish": "yarn lerna publish from-package --dist-tag canary --yes --no-verify-access",
"changelog": "lerna-changelog",
"postinstall": "run-p postinstall:**",

14
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:
- `latest`: stable releases (example: `2.0.0-beta.0`)
- `canary`: canary releases (example: `2.0.0-beta.4a6de5cf7`)
- `canary`: canary releases (example: `2.0.0-beta.0.1234.4a6de5cf7`)
:::tip
@ -31,15 +31,15 @@ Make sure to use the latest canary release and check the publication date (somet
## 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.4a6de5cf7`).
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`).
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.4a6de5cf7",
+ "@docusaurus/preset-classic": "2.0.0-beta.4a6de5cf7",
+ "@docusaurus/core": "2.0.0-beta.0.1234.4a6de5cf7",
+ "@docusaurus/preset-classic": "2.0.0-beta.0.1234.4a6de5cf7",
```
Then, install the dependencies again and start your site:
@ -55,6 +55,12 @@ 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.