chore(spec): generate swag via go tool directive for reproducibility#597
Open
Fodesu wants to merge 1 commit into
Open
chore(spec): generate swag via go tool directive for reproducibility#597Fodesu wants to merge 1 commit into
Fodesu wants to merge 1 commit into
Conversation
The swagger go:generate directive used `swag@latest`, which is non-deterministic: it ignores the `swag v1.16.6` already pinned in go.mod and resolves to whatever version the toolchain returns, so regenerating produces spurious diffs that vary by machine/time. Register cmd/swag as a go.mod `tool` dependency and switch the directive to `go tool swag`, so generation always uses the version pinned in go.mod. Future bumps only touch go.mod (`go get -tool ...`), not swagger.go. Regenerating with the pinned v1.16.6 also brings the committed spec back in sync with source: it adds the `/users/me` 401 response (declared via `@Failure 401` since memohai#579) and normalizes operation key ordering. The SDK type for that 401 is synced; the SDK SSE runtime files are left untouched.
Fodesu
changed the title
Fodesu
force-pushed
the
chore/pin-generators-regen-sdk
branch
from
fc59fd7 to
ec19224
Compare
Member
Author
|
@codex review |
|
Codex Review: Didn't find any major issues. Nice work! ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
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.
Summary
The swagger
go:generatedirective usedswag@latest, which isnon-deterministic — it ignores the
swag v1.16.6pinned ingo.modandresolves to whatever version the toolchain returns, so regenerating produces
spurious diffs that vary by machine/time.
Register
cmd/swagas a go.modtooldependency and switch the directive togo tool swag, so generation always uses the version pinned ingo.mod.Future bumps only touch
go.mod(go get -tool ...), neverswagger.go.Regenerating with the pinned v1.16.6 also syncs a stale spec:
GET /users/medeclares
@Failure 401in source (since #579) but the committed spec/SDK neverincluded it.
Changes
internal/handlers/swagger.go:go run …swag@v1.16.6→go tool swag.go.mod/go.sum: add thetool github.com/swaggo/swag/cmd/swagdirective.spec/{swagger.json,swagger.yaml,docs.go}: regenerated; adds the missing401onGET /users/meand normalizes operation key ordering.packages/sdk/src/types.gen.ts: the corresponding401type.