feat!: regenerate from protocol v237.1.3 and move the module to /v6 - #147
Open
mogita wants to merge 1 commit into
Open
feat!: regenerate from protocol v237.1.3 and move the module to /v6#147mogita wants to merge 1 commit into
mogita wants to merge 1 commit into
Conversation
Six generated types changed shape. Nothing was removed: no endpoint, type or field
disappeared, and no field was added.
ChannelMemberRequest.UserID string -> *string
ChannelMemberRequest.User *UserResponse -> *MemberUserRequest
Reminder{Created,Updated,Deleted,Notification}Event.Reminder
*ReminderResponseData -> ReminderResponseData
oasdiff reports 44 errors between openapi-v236.2.0 and openapi-v237.1.3, all
request-property-type-changed, which matches the first two rows.
Go resolves a v2+ module only if go.mod carries the matching suffix, and
release-please does not rewrite it, so go.mod and all 76 self-imports move to
/v6 in this commit. That has to land before the major Release PR merges,
otherwise the guard in release.yml refuses to tag. CHANGELOG.md and
MIGRATION_v4_to_v5.md keep their /v5 references as historical record.
MIGRATION_v5_to_v6.md documents the four call-site changes. The 15 affected
lines in the hand-written tests use the existing PtrTo helper.
BREAKING CHANGE: module path is now github.com/GetStream/getstream-go/v6, and
ChannelMemberRequest.UserID, ChannelMemberRequest.User and the Reminder field on
the four reminder events changed type. See MIGRATION_v5_to_v6.md.
mogita
had a problem deploying
to
feeds-enabled-shard
August 26, 2026 13:25 — with
GitHub Actions
Failure
mogita
had a problem deploying
to
feeds-enabled-shard
August 26, 2026 13:30 — with
GitHub Actions
Failure
mogita
had a problem deploying
to
feeds-enabled-shard
August 26, 2026 16:01 — with
GitHub Actions
Failure
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.
Problem
getstream-gois generated from protocolopenapi-v236.2.0. The current release,openapi-v237.1.3, changes the shape of six generated types, which breaks Go call sites even though nothing was removed from the API.Solution
Regenerated against
openapi-v237.1.3and moved the module to/v6.No endpoint, type or field was removed, and no field was added.
oasdiffbetween the two specs reports 44 errors, allrequest-property-type-changed, matching the first two rows.Go resolves a v2+ module only if
go.modcarries the matching suffix, and release-please never rewrites it, sogo.modand all 76 self-imports move to/v6here. This has to be onmainbefore the major Release PR merges, or the guard inrelease.ymlrefuses to tag.CHANGELOG.mdandMIGRATION_v4_to_v5.mdkeep their/v5references as historical record.MIGRATION_v5_to_v6.mddocuments the four call-site changes. The 15 affected lines in the hand-written tests use the existingPtrTohelper.How to verify
head -1 go.modshowsmodule github.com/GetStream/getstream-go/v6.grep -rl "getstream-go/v5" . --exclude-dir=.gitlists onlyCHANGELOG.mdandMIGRATION_v4_to_v5.md../generate.shproduces no diff beyond.spec-versionif a newer protocol release has landed since.go build ./... && go vet ./... && go test -short ./...all pass.Review instructions
Merge order matters. PR #145 is open proposing 5.4.0 from base 5.3.0. If this merges first, release-please recomputes that same PR as 6.0.0 and 5.4.0 never ships. Merge #145 first if you want 5.4.0 to exist.
Expect the Release workflow to go red on the push that lands this PR:
mainwill carrygo.modat/v6while the manifest still says 5.3.0 or 5.4.0, and the guard fails on that mismatch by design. It blocks only the tagging step, not the Release PR, and it clears once the 6.0.0 Release PR merges.