3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-08-03 00:39:45 +02:00
Code Issues Projects Releases Packages Wiki Activity

chore(v2): prepare v2.0.0-beta.3 release (#5098)

Browse source 
* beta.3

* publish guide

* publish guide

* v2.0.0-beta.3
This commit is contained in:
Sébastien Lorber 2021-06-30 16:05:49 +02:00 • committed by GitHub
parent 9b9f38cd50
commit 1ec2c95e3d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
102 changed files with 12168 additions and 155 deletions
Download patch file Download diff file Expand all files Collapse all files

29
admin/publish.md
View file

@ -43,29 +43,30 @@ git pull
git co -b <your_username>/<version_to_release>
```
### 2. Build and test the project
### 2. Clean, Build and test the project
Run `yarn install`
It should run `yarn build:packages` and build the project's packages.
To make sure that all packages will work correctly when they are published, we can initialize a new D2 skeleton website, and test that it can start/built.
Build all the packages from a clean state:
```sh
yarn test:build:v2
yarn clear
yarn install
```
This command will build all the packages that it will publish to the running private npm proxy registry, and then initialize a new website in the `test-website` directory. Now you can start the dev server and/or make a production built.
**Optional**: to make sure that all packages will work correctly when they are published, we can initialize a new D2 skeleton website, and test that it can start/built.
```sh
# This will build all the packages and publish them in a local Verdaccio npm registry
# and then initialize a new website in the `test-website` directory using those locally published packages
yarn test:build:v2
# Now you can test the site in dev/prod mode
cd test-website
yarn start
yarn build # after manual testing in browser
yarn build
yarn serve
```
If there are no errors, you can start preparing for the new release.
**Note**: This step is also run by the CI on all pull requests ([see](https://github.com/facebook/docusaurus/pull/2954/checks?check_run_id=780871959))
This local test step is optional because it will be run by the CI on your release PR ([see](https://github.com/facebook/docusaurus/pull/2954/checks?check_run_id=780871959))
### 3. Update the v2 changelog
@ -113,9 +114,9 @@ You should still be on your local branch `<your_username>/<version_to_release>`
Make a commit/push, create a pull request with the changes.
**Don't merge it yet**, but wait for the CI checks to complete.
Example PR: [#3114](https://github.com/facebook/docusaurus/pull/5098), using title such as `chore(v2): prepare v2.0.0-beta.0 release`
An example PR would be [#3114](https://github.com/facebook/docusaurus/pull/3114).
**Don't merge it yet**, but wait for the CI checks to complete.
### 6. Build and publish to npm