docs(sdk): document how the Go SDK is released - #1088
Merged
Conversation
The Go SDK has no publish workflow and cannot have one — Go has no registry to push to, so tagging IS the release. Nothing recorded that, so the module has only ever been resolvable as a pseudo-version. The tag must carry the sdk/go/ module prefix. Empirically confirmed: the repo already has bare v* app tags, and proxy.golang.org still answers v0.0.0-<date>-<commit> for the module, because a bare tag does not apply to a module in a subdirectory. Also records two things that bite silently: DefaultUserAgent in options.go carries the SDK version and drifts if only the tag moves, and a published module version is immutable once the proxy caches it — deleting the tag does not take it back. Left as-is: this file is not Prettier-clean on main and markdown is not gated by CI, so reformatting would bury the change in noise.
rmyndharis
force-pushed
the
docs/go-sdk-release-tagging
branch
from
August 6, 2026 03:17
aedabe2 to
ea9341b
Compare
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
1 participant
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.
The Go SDK has no publish workflow and cannot have one — Go has no registry to push to, so tagging is the release. Nothing in the repository recorded that, which is why the module has only ever been resolvable as a pseudo-version.
The load-bearing detail
The tag must carry the
sdk/go/module prefix, because the module lives in a subdirectory rather than at the repository root.This is empirically confirmed rather than asserted: the repo already has bare
v*app tags, andproxy.golang.orgstill answersv0.0.0-<date>-<commit>forgithub.com/rmyndharis/OpenWA/sdk/go— a bare tag does not apply to a module in a subdirectory. Sogo getworks today, but callers cannot pin a release.Also recorded
DefaultUserAgentinoptions.gocarries the SDK version (openwa-go/0.1.0) and is sent on every request. It drifts silently if only the tag moves.retractdirective. So tag a commit already green onmain.Scope
Docs only, deliberately. There is no publish step to automate, and
sdk-ci.ymlalready testssdk/goon every push tomain, so a tag-triggered test job would re-run a check that has already passed on the same commit — after the tag is public and immutable, when it can no longer prevent anything.Not reformatted: the file is not Prettier-clean on
mainand markdown is not gated by CI.