From e5ff417cd19a4d9c353c2a054a42cf75d5df9228 Mon Sep 17 00:00:00 2001 From: Joel Marcey Date: Sat, 26 May 2018 11:40:35 -0700 Subject: [PATCH] Update publish.md with more details --- admin/publish.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/admin/publish.md b/admin/publish.md index 85b7c711be..a18b47dcf7 100644 --- a/admin/publish.md +++ b/admin/publish.md @@ -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?