mirror of
https://github.com/facebook/docusaurus.git
synced 2025-12-30 05:52:50 +00:00
3971f803bc
* chore: add prerelease script * Update prerelease.md * Update prerelease.sh * Update prerelease.sh * chore: address review * update instruction * alias 'run version' to make it clear we're running docs version * indicate that we are creating commit, not pull request * update asciinema preview * nits
27 lines
986 B
Markdown
27 lines
986 B
Markdown
# Prereleasing New Version of Docusaurus
|
|
|
|
[](https://asciinema.org/a/hZ7NNJPcgtdvzm5tMLLfHflMD)
|
|
|
|
# Steps
|
|
|
|
1. Ensure that `origin` remote is your Docusaurus fork and `upstream` is Docusaurus original repository.
|
|
|
|
```bash
|
|
$ git remote -v
|
|
origin https://github.com/endiliey/Docusaurus.git (fetch)
|
|
origin https://github.com/endiliey/Docusaurus.git (push)
|
|
upstream https://github.com/facebook/Docusaurus.git (fetch)
|
|
upstream https://github.com/facebook/Docusaurus.git (push)
|
|
```
|
|
|
|
2. Pull latest changes from Docusaurus repository.
|
|
|
|
```bash
|
|
$ git fetch upstream && git checkout master && git merge upstream/master
|
|
```
|
|
|
|
2. Modify `CHANGELOG.md` and other necessary files. Do not commit the changes.
|
|
3. Run `bash scripts/prerelease.sh`.
|
|
4. Create your pull request on GitHub.
|
|
|
|
<img width="629" alt="pull request" src="https://user-images.githubusercontent.com/17883920/43393765-ccb050ac-942a-11e8-94e8-d585034fa064.PNG"> |