From f8807e80df59de13d90f1d5cf262057eda919cca Mon Sep 17 00:00:00 2001 From: Daniel Playfair Cal Date: Thu, 19 Sep 2019 17:04:29 +1000 Subject: [PATCH] docs(development): update the release instructions to something that actually works (#57) --- docs/development/publishing.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/development/publishing.md b/docs/development/publishing.md index b2038744f..5c263fa91 100644 --- a/docs/development/publishing.md +++ b/docs/development/publishing.md @@ -1,10 +1,15 @@ # Publishing new versions -Publishing is done with lerna: - -```shell -$ yarn run lerna publish -``` +1. Set up a personal access token in github with push access to the repository. + Add the token to the environment with `$ export GH_TOKEN=`. This is to + annotate the tags with github releases. +1. Authenticate with the NPM CLI (verify with `$ npm whoami`) +1. Temporarily disable branch protection on the repository (the lerna release + script needs to push to master) +1. Do the release with lerna: + `$ yarn run lerna publish [prerelease] [--preid ]`. This is the point + of no return, if it succeeds in creating the releases on NPM. +1. Turn branch protection back on There will be a prompt to confirm the new versions of packages to be published. Changelogs will automatically be generated and new version numbers chosen based