From 27aa27a7508e8d33484f95c11cedd6bc6ec73247 Mon Sep 17 00:00:00 2001 From: Joe Clark Date: Sat, 13 Jan 2024 16:41:45 +0000 Subject: [PATCH] update readme with new release stuff --- README.md | 41 +++++++++++++---------------------------- 1 file changed, 13 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index 356eb14e4..1dc49e50b 100644 --- a/README.md +++ b/README.md @@ -238,38 +238,23 @@ Commit the changeset to the repo when you're ready. ## Releases -To release, run this from the root: +New releases will be published to npm automatically when merging into the `main` +branch`. -``` -pnpm changeset version -``` +Version numbers should be bumped with `changeset` and git tags should be pushed +to the release branch BEFORE merging. -This will bump all changed packages and update their release notes. +1. Run `pnpm changeset version` from root to bump versions +1. Run `pnpm install` +1. Commit the new version numbers +1. Run `pnpm changeset tag` to generate tags +1. Push tags `git push --tags` -Then install packages and commit changes with: +Rememebr tags may need updating if commits come in after the tags are first +generated. -``` -pnpm install -``` - -Build the adaptors with: - -``` -pnpm -r run build -``` - -To publish the release, run: - -``` -pnpm changeset publish -``` - -And finally, push the tags to Github so that the source code can be browsed for -each new release with: - -``` -git push --follow-tags -``` +When ready, merge the branch to main and a Github Action will trigger the +release. ## Build tooling