Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 7dc1473

Browse files
authored
Name release branches just after major.minor (#10013)
With the prior format, 1.33.0 / 1.33.1 / 1.33.2 got separate branches: release-v1.33.0 release-v1.33.1 release-v1.33.2 Under the new model, all three would share a common branch: release-v1.33 As before, RCs and actual releases exist as tags on these branches. This better reflects our support model, e.g., that the "1.33" series had a formal release followed by two patches / updates. Signed-off-by: Dan Callahan <[email protected]>
1 parent c842c58 commit 7dc1473

File tree

3 files changed

+6
-5
lines changed

3 files changed

+6
-5
lines changed

changelog.d/10013.misc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Simplify naming convention for release branches to only include the major and minor version numbers.

docs/dev/git.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -122,15 +122,15 @@ So, what counts as a more- or less-stable branch? A little reflection will show
122122
that our active branches are ordered thus, from more-stable to less-stable:
123123

124124
* `master` (tracks our last release).
125-
* `release-vX.Y.Z` (the branch where we prepare the next release)<sup
125+
* `release-vX.Y` (the branch where we prepare the next release)<sup
126126
id="a3">[3](#f3)</sup>.
127127
* PR branches which are targeting the release.
128128
* `develop` (our "mainline" branch containing our bleeding-edge).
129129
* regular PR branches.
130130

131131
The corollary is: if you have a bugfix that needs to land in both
132-
`release-vX.Y.Z` *and* `develop`, then you should base your PR on
133-
`release-vX.Y.Z`, get it merged there, and then merge from `release-vX.Y.Z` to
132+
`release-vX.Y` *and* `develop`, then you should base your PR on
133+
`release-vX.Y`, get it merged there, and then merge from `release-vX.Y` to
134134
`develop`. (If a fix lands in `develop` and we later need it in a
135135
release-branch, we can of course cherry-pick it, but landing it in the release
136136
branch first helps reduce the chance of annoying conflicts.)
@@ -145,4 +145,4 @@ most intuitive name. [^](#a1)
145145

146146
<b id="f3">[3]</b>: Very, very occasionally (I think this has happened once in
147147
the history of Synapse), we've had two releases in flight at once. Obviously,
148-
`release-v1.2.3` is more-stable than `release-v1.3.0`. [^](#a3)
148+
`release-v1.2` is more-stable than `release-v1.3`. [^](#a3)

scripts-dev/release.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ def run():
139139
click.get_current_context().abort()
140140

141141
# Switch to the release branch.
142-
release_branch_name = f"release-v{base_version}"
142+
release_branch_name = f"release-v{current_version.major}.{current_version.minor}"
143143
release_branch = find_ref(repo, release_branch_name)
144144
if release_branch:
145145
if release_branch.is_remote():

0 commit comments

Comments
 (0)