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

Update publish.md with more details

This commit is contained in:
Joel Marcey 2018-05-26 11:40:35 -07:00 committed by GitHub
parent 01bc5e4dd5
commit e5ff417cd1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
admin/publish.md
View File

@ -12,9 +12,14 @@ If you are not currently logged into npm locally:
## Publish
1. Bump version number in [`package.json`](https://github.com/facebook/Docusaurus/blob/master/package.json).
1. Update the [changelog](https://github.com/facebook/Docusaurus/blob/master/CHANGELOG.md).
1. Run `npm install` and `yarn install` to update `package-lock.json` and/or `yarn.lock`.
1. Update the [changelog](https://github.com/facebook/Docusaurus/blob/master/CHANGELOG.md), including at the reference links at the bottom.
1. Do this always, but particularly important if there were any `package.json` changes in this release:
1. If there is no `node_modules` directory in you local Docusaurus version, run `yarn install` or `npm install`.
1. Run `yarn upgrade` to update `yarn.lock` and `npm update` to update `package-lock.json`.
1. From the `website` directory, run `npm run version x.x.x`, where x.x.x is the same version number you updated to in `package.json`.
1. Test your PR locally on a project that was created via [these instructions](https://github.com/facebook/Docusaurus/blob/master/admin/local-third-party-project-testing.md).
1. Submit your PR
1. When your PR is merged, rebase to get the PR commit locally.
1. Run `npm publish`
### What version should you use?