Skip to content

docs(releasing): Document the two-PR flow for cmd/s2-server#132

Merged
mojatter merged 1 commit into
mainfrom
docs/releasing-two-pr-flow
May 31, 2026
Merged

docs(releasing): Document the two-PR flow for cmd/s2-server#132
mojatter merged 1 commit into
mainfrom
docs/releasing-two-pr-flow

Conversation

@mojatter
Copy link
Copy Markdown
Owner

The release guide described a single PR that bumps every submodule — including cmd/s2-server — and tags all seven modules at once. That does not work: cmd/s2-server has no replace directives, so its GOWORK=off build (the e2e image via server/Dockerfile, and the GoReleaser binary) resolves intra-repo deps from proxy.golang.org and cannot fetch a version whose tag does not exist yet. Both v0.11.0 (#119#120) and v0.11.1 (#130#131) actually used a two-PR flow.

This rewrites the flow to match reality:

  • Step 1 bumps only the five modules that carry replace directives; cmd/s2-server is explicitly excluded.
  • Step 2 tags six modules (root + five submodules), not seven. Adds a note that the binary built at the root tag still links the previous library version, why that is fine for dependency/security bumps (MVS picks the higher version pinned directly in cmd/s2-server/go.mod, e.g. golang.org/x/net), and when to reorder.
  • Step 3 (new) bumps cmd/s2-server in a follow-up PR once the tags are published, then tags cmd/s2-server/v*.
  • Step 4 is the former step 3 (release notes), example versions refreshed to v0.11.1.
  • The matching gotcha bullet is updated to point at the new step 3.

The single-PR instruction would break e2e: cmd/s2-server has no replace
directives, so its GOWORK=off build cannot resolve the not-yet-published
version. Tag the five replace-modules first, then bump and tag
cmd/s2-server separately - matching what v0.11.0/v0.11.1 actually did.
@mojatter mojatter merged commit 1821d0c into main May 31, 2026
2 checks passed
@mojatter mojatter deleted the docs/releasing-two-pr-flow branch May 31, 2026 07:29
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.

1 participant