Skip to content

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.

Sign up for GitHub

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

Closed
alexhancock wants to merge 1 commit into from
Closed

docs: clarify RELEASE PR descriptions #5711

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions .github/actions/generate-release-pr-body/pr_body_template.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,20 @@
## How to Release

Push the release tag to trigger the release:
```bash
git fetch && git tag v{{VERSION}} origin/release/{{VERSION}}
git push origin v{{VERSION}}
```

```bash
git fetch
git checkout release/{{VERSION}}
git cherry-pick DESIRED_COMMIT_SHA(s)
Copy link
Collaborator

@jamadeo jamadeo Nov 14, 2025

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

Copy link
Collaborator Author

@alexhancock alexhancock Nov 14, 2025 •
edited
Loading

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

Copy link
Collaborator

@jamadeo jamadeo Nov 14, 2025

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)

Copy link
Collaborator

@jamadeo jamadeo Nov 14, 2025

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 push

Once ready to release, run

git fetch && git tag v{{VERSION}} origin/release/{{VERSION}}
git push origin v{{VERSION}}

git tag v{{VERSION}}
git push origin v{{VERSION}}
```

This PR will auto-merge once the tag is pushed.

## Important Notes

- All commits in this release should have corresponding cherry-picks in `main`
- All commits cherrypicked into this release should be from `main`
Copy link

Copilot AI Nov 13, 2025

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.

Suggested change
- All commits cherrypicked into this release should be from `main`
- All commits cherry-picked into this release should be from `main`

Copilot uses AI. Check for mistakes.
- This PR can be closed if the release is not needed.

## Changes in This Release
Expand Down
Loading