Skip to content

Commit

Permalink
Update publish.md with more details
Browse files Browse the repository at this point in the history
  • Loading branch information
JoelMarcey authored May 26, 2018
1 parent 01bc5e4 commit e5ff417
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions admin/publish.md
Original file line number Diff line number Diff line change
Expand Up @@ -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?
Expand Down

0 comments on commit e5ff417

Please sign in to comment.