docs(release): Modify release script to include exact gh commands#451
Merged
Conversation
heyitsaamir
force-pushed
the
aamirj/release-md-fixes
branch
from
b7045d4 to
1d2e4b3
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
Updates RELEASE.md to document the actual long-lived release branch workflow, including a recommended preparation approach that avoids recurring merge-base/phantom-conflict issues caused by prior squash merges.
Changes:
- Clarifies that
releaseis long-lived and releases are prepared by bringingmainintoreleasevia a PR (rather than creating a new release branch). - Documents a
git merge -s ours origin/releaseworkflow to re-establish clean merge ancestry going forward. - Refreshes version examples to 2.0.13 and replaces
tacwith a portableawkone-liner.
heyitsaamir
force-pushed
the
aamirj/release-md-fixes
branch
3 times, most recently
from
ac662fb to
4aafe87
Compare
- Clarify that release is long-lived, not created fresh per release - Document the -s ours pattern to avoid phantom conflicts from prior squash-merges - Update example versions to current (2.0.13) - Replace tac (not on macOS) with awk one-liner
heyitsaamir
force-pushed
the
aamirj/release-md-fixes
branch
from
4aafe87 to
f501314
Compare
heyitsaamir
changed the title
lilyydu
approved these changes
Jun 8, 2026
corinagum
approved these changes
Jun 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
In the previous doc, the instruction was to do main -> release. But since release and main have different histories, there were many merge conflicts that had to be resolved. To do this, we had to use
-s ourswhen merging.Since this needs to be done on our machine anyway (and also because version.json also needs to be modified), I updated the doc to just be exact commands that need to be run so agents can help us execute the release workflow quickly.