From ed579fea5fedeb407f2cf58d63da3530cf0a374d Mon Sep 17 00:00:00 2001 From: Cameron Yick Date: Wed, 15 Sep 2021 20:46:29 -0400 Subject: [PATCH] docs(publish): document the updated release process --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 774e6fe4..6082ea16 100644 --- a/README.md +++ b/README.md @@ -220,4 +220,9 @@ To build `vega-embed.js` and view the test examples, you must have [yarn](https: ## Release Process -To release a new version, make sure that everything works. Then run `yarn version` and bump the version number. Lastly, push to GitHub (with the release tag). GitHub Actions will build a bundle and make the [npm release](https://www.npmjs.com/package/vega-embed) automatically. +Publishing is handled by a 2-branch [pre-release process](https://intuit.github.io/auto/docs/generated/shipit#next-branch-default), configured in `publish.yml`. All changes should be based off the default `next` branch, and are published automatically. + +- PRs made into the default branch that [would trigger a version bump](https://intuit.github.io/auto/docs/generated/conventional-commits) are auto-deployed to the `next` pre-release tag on NPM. The result can be installed with `npm install vega-embed/@next`. + - When merging into `next`, please use the `squash and merge` strategy. +- To release a new stable version, open a PR from `next` into `stable` using this [compare link](https://github.com/vega/vega-embed/compare/stable...next). + - When merging from `next` into `stable`, please use the `create a merge commit` strategy.