Update go client README to match modern module support#23292
Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom Mar 20, 2026
Merged
Update go client README to match modern module support#23292wing328 merged 2 commits intoOpenAPITools:masterfrom
wing328 merged 2 commits intoOpenAPITools:masterfrom
Conversation
Updated go client installation instructions to use go modules explicitly.
Contributor
There was a problem hiding this comment.
6 issues found across 12 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="samples/openapi3/client/extensions/x-auth-id-alias/go-experimental/README.md">
<violation number="1" location="samples/openapi3/client/extensions/x-auth-id-alias/go-experimental/README.md:15">
P2: Installation instructions rely on unresolved template module path, so `go mod tidy` may fail unless users manually reconfigure module/replace settings.</violation>
</file>
<file name="samples/client/echo_api/go-external-refs/README.md">
<violation number="1" location="samples/client/echo_api/go-external-refs/README.md:15">
P2: Installation instructions can cause a failing `go mod tidy` flow by asking for a named import without any package usage.</violation>
</file>
<file name="samples/client/others/go/allof_multiple_ref_and_discriminator/README.md">
<violation number="1" location="samples/client/others/go/allof_multiple_ref_and_discriminator/README.md:15">
P2: Installation instructions imply direct module fetching via `go mod tidy` while still using placeholder import path, which can fail module resolution for users following README as-is.</violation>
</file>
<file name="samples/openapi3/client/petstore/go/go-petstore-aws-signature/README.md">
<violation number="1" location="samples/openapi3/client/petstore/go/go-petstore-aws-signature/README.md:15">
P2: Installation instructions now require `go mod tidy` but still use placeholder module coordinates, which can cause dependency resolution failure unless users customize module path or add local replacement.</violation>
</file>
<file name="samples/client/petstore/go/go-petstore/README.md">
<violation number="1" location="samples/client/petstore/go/go-petstore/README.md:15">
P2: Installation instructions now depend on `go mod tidy` resolving a placeholder module path, which is not valid as-is and can break users following the README literally.</violation>
</file>
<file name="modules/openapi-generator/src/main/resources/go/README.mustache">
<violation number="1" location="modules/openapi-generator/src/main/resources/go/README.mustache:23">
P2: Installation instructions now imply remote module availability only, which can break local/unpublished generated client workflows when users run `go mod tidy`.</violation>
</file>
Since this is your first cubic review, here's how it works:
- cubic automatically reviews your code and comments on bugs and improvements
- Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
- Add one-off context when rerunning by tagging
@cubic-dev-aiwith guidance or docs links (includingllms.txt) - Ask questions if you need clarification on any suggestion
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
samples/openapi3/client/extensions/x-auth-id-alias/go-experimental/README.md
Show resolved
Hide resolved
Contributor
Author
|
AI review does not seem relevant -- |
Contributor
Author
|
@cubic-dev-ai re-review. |
Contributor
@deltamualpha I have started the AI code review. It will take a few minutes to complete. |
Member
|
thanks for the contribution which has been merged |
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.
Updated go client installation instructions to use go modules explicitly. This is a documentation-only update that aligns the generated go client with go modules, which has been the ecosystem standard for over six years.
Mentioning the go client owners:
@antihax @grokify @kemokemo @jirikuncar @ph4r5h4d @lwj5
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Switch Go client installation docs to Go Modules for a simpler, modern setup. Replaces manual go get steps with “import the package and run
go mod tidy,” updating the generator README template and all regenerated sample READMEs.Written for commit ff2458c. Summary will update on new commits.