From 53684fe36aa3ca6c4ed0da899c013c32d3cb6c63 Mon Sep 17 00:00:00 2001 From: Alex Eagle Date: Thu, 16 Aug 2018 14:08:02 -0700 Subject: [PATCH] docs: add some missing release bits (#11921) --- docs/process/release.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/process/release.md b/docs/process/release.md index b4ef15578f..6ae8870750 100644 --- a/docs/process/release.md +++ b/docs/process/release.md @@ -44,10 +44,15 @@ Only the first 2 commits should be cherry picked to the patch branch, as the las ## Shepparding As commits are cherry-picked when PRs are merged, creating the release should be a matter of updating the version -numbers. This can be done with the following command (for patch): +numbers. This can be done with the following command. + +See `scripts/release.ts` for the full list of release types, e.g. patch updates the third number per semver. ```bash -devkit-admin release patch --force +devkit-admin release patch --force # replace with minor-beta etc. +git commit -a -m 'release: vXX' +git tag 'vXX' +git push upstream && git push upstream --tags ``` ### Publishing @@ -68,13 +73,14 @@ devkit-admin publish --tag next ### Release Notes -Running the following command will output the release notes on stdout between v1.2.3 and 1.2.4: +`devkit-admin changelog` takes `from` and `to` arguments which are any valid git ref. +For example, running the following command will output the release notes on stdout between v1.2.3 and 1.2.4: ```bash devkit-admin changelog --from=v1.2.3 --to=v1.2.4 ``` -Copy paste the output (you can use `| pbcopy` on MacOS) and create the release notes on github for the tag just +Copy paste the output (you can use `| pbcopy` on MacOS or `|xclip` on Linux) and create the release notes on github for the tag just released. If you have an API token for GitHub you can create a draft automatically by using the `--githubToken` flag. You just have then to confirm the draft.