From 618c0ae1373f37aef5e9799bd564cb9ded8fb587 Mon Sep 17 00:00:00 2001 From: Alex Hancock Date: Mon, 25 Aug 2025 11:33:07 -0400 Subject: [PATCH] docs: improvements to release docs --- RELEASE.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/RELEASE.md b/RELEASE.md index 56d135146da1..61ba5e86f1e1 100644 --- a/RELEASE.md +++ b/RELEASE.md @@ -6,12 +6,12 @@ You'll generally create one of two release types: a regular feature release (min 1. Check out the main branch. 1. Pick the new version. Use a new minor version (e.g. if the current latest release is 1.2.3, use 1.3.0). Save it using `export VERSION=` -1. Run `just prepare-release $VERSION`. This will create a branch `release/`. Push this branch and open a PR into main. The diff should show version updates to Cargo.toml/package.json and their lock files. -1. This should trigger a signed macOS build -- Github actions will comment on the PR when it's ready. Test this build. When ready to make the release, proceed to the next step. -1. Run git branch --set-upstream-to origin/release/$VERSION -1. Tag the release: run `just tag-push` to create the tag and push it. This will start the build process for your new release. -1. Merge the PR you created in step 2. -1. Once the release is created on [Github](https://github.com/block/goose/releases), run `just release-notes ` to generate release notes. Copy these into the release description. +1. Run `just prepare-release $VERSION`. This will create a branch `release/` +1. Run `git push origin release/ --set-upstream` and open a PR into `main`. Use `git log --oneline --cherry-pick --right-only v...release/$VERSION` to generate a PR description +1. Wait for the bundled version of the app which will be linked from a comment on the PR +1. Test the bundled version of the app +1. When ready, tag the release: run `just tag-push` to create the tag and push it. This will start the release process +1. Once the release is created on [Github](https://github.com/block/goose/releases), merge the PR and run `just release-notes ` to generate release notes. Copy these into the release description. ## Patch release