-
Notifications
You must be signed in to change notification settings - Fork 2k
docs: clarify RELEASE PR descriptions #5711
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR clarifies the instructions in the release PR template based on the author's experience with an actual release (v1.14.2). The changes make the release process more explicit by breaking down git commands and updating the guidance about cherry-picking commits.
- Expands git commands into individual steps for clarity
- Updates cherry-pick guidance to reflect actual workflow
- Improves the wording about commit origins
| ## Important Notes | ||
|
|
||
| - All commits in this release should have corresponding cherry-picks in `main` | ||
| - All commits cherrypicked into this release should be from `main` |
Copilot
AI
Nov 13, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The word "cherrypicked" should be hyphenated as "cherry-picked" to match standard Git terminology and the command usage on line 10.
| - All commits cherrypicked into this release should be from `main` | |
| - All commits cherry-picked into this release should be from `main` |
c690a37 to
653c212
Compare
| ```bash | ||
| git fetch | ||
| git checkout release/{{VERSION}} | ||
| git cherry-pick DESIRED_COMMIT_SHA(s) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the cherry pick shouldn't happen at this step ideally -- what you'd do is first push commits to this branch and let the PR checks do their thing. Then when ready to release, fetch this branch, tag it, and push the tag
maybe what's missing is just a bit about how to push a cherry-pick to this PR branch
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Oh! You were thinking a workflow where we commit to release branches, then cherry-pick into main?
I had still been thinking we would make commits to main to address issues, then cherry-pick them into release branches, then tag and trigger the release
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No I did mean commit first to main, but the way the commands are sequenced here looks like you'd do the tag right after a cherry-pick. I'd just break those into two steps: 1) cherry-picking (possibly many) commits from main into this branch and pushing them, and then 2) once ready, tagging the release
The first version of this snippet only covered 2)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Something like:
To add commits from main to this release, run:
git fetch
git checkout release/{{VERSION}}
git cherry-pick DESIRED_COMMIT_SHA(s)
git pushOnce ready to release, run
git fetch && git tag v{{VERSION}} origin/release/{{VERSION}}
git push origin v{{VERSION}}
@jamadeo Let me know if you see this as more clear.
I ran into the snippet included in the old description not pushing the tag when prepping #5709 unless I mis-ran something. I did something manually and then reverse engineered these docs from the process I did.
Also, that branch did not merge when I pushed the tag https://github.com/block/goose/releases/tag/v1.14.2
Something may be failing in an automatic merge action?