Skip to content

docs: cut release branch and tag from master, not the feature branch - #708

Open
likhithThammegowda wants to merge 1 commit into
masterfrom
docs/release-branch-from-master
Open

docs: cut release branch and tag from master, not the feature branch#708
likhithThammegowda wants to merge 1 commit into
masterfrom
docs/release-branch-from-master

Conversation

@likhithThammegowda

Copy link
Copy Markdown
Contributor

Docs-only. No release notes — this isn't being released.

Problem

The release runbook contradicted itself. One line said to cut release artifacts from the merged trunk commit; another said a release run could create the GitHub Release and the branch/tag before the master merge. Following the second reading produced release-4.2.9 and release-4.2.11 as branches pointing at fix-branch commits, so the deployed artifact was not reachable from master — it diverged from the trunk and from what reviewers approved.

Change

  • State the rule once: release-X.Y.Z and vX.Y.Z are always cut from master, never from the feature/fix branch, with the exact commands.
  • Correct the flow line to include wait for the merge before the branch/tag step.
  • Record that master requires 2 approving reviews and cannot be merged programmatically (the API returns 405), so automation stops at opening the PR.
  • Add the --title "Release-X.Y.Z" flag the documented gh release create command was missing — without it the release title defaults to the tag name, which is not the convention.

release-4.2.9 and release-4.2.11 are left as published; the rule applies from 4.2.12 onward.

The runbook contradicted itself: one line said to cut release artifacts from the
merged trunk commit, another said a release run could create the branch and tag
before the master merge. Following the second produced 4.2.9 and 4.2.11 as
release branches pointing at fix-branch commits, so the deployed artifact was
not reachable from master.

State the rule once, with the commands, and record that master needs two
approving reviews and cannot be merged programmatically — so the flow stops at
the PR and the branch/tag come afterwards, from master.

Also adds the --title "Release-X.Y.Z" flag that the documented gh command was
missing; without it the release title defaults to the tag name.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants