Skip to content

Update go client README to match modern module support#23292

Merged
wing328 merged 2 commits intoOpenAPITools:masterfrom
deltamualpha:patch-1
Mar 20, 2026
Merged

Update go client README to match modern module support#23292
wing328 merged 2 commits intoOpenAPITools:masterfrom
deltamualpha:patch-1

Conversation

@deltamualpha
Copy link
Copy Markdown
Contributor

@deltamualpha deltamualpha commented Mar 19, 2026

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

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in WSL)
    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.
  • File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

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.

deltamualpha and others added 2 commits March 19, 2026 10:34
Updated go client installation instructions to use go modules explicitly.
Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-ai with guidance or docs links (including llms.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.

@deltamualpha
Copy link
Copy Markdown
Contributor Author

AI review does not seem relevant -- github.com/GIT_USER_ID/GIT_REPO_ID is indeed invalid, but that's the output that's always been present in the generated example files, since the example scripting doesn't set the required git options in the generator call.

@deltamualpha
Copy link
Copy Markdown
Contributor Author

@cubic-dev-ai re-review.

@cubic-dev-ai
Copy link
Copy Markdown
Contributor

cubic-dev-ai bot commented Mar 20, 2026

@cubic-dev-ai re-review.

@deltamualpha I have started the AI code review. It will take a few minutes to complete.

Copy link
Copy Markdown
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 12 files

@wing328 wing328 merged commit 29035c7 into OpenAPITools:master Mar 20, 2026
21 of 22 checks passed
@wing328
Copy link
Copy Markdown
Member

wing328 commented Mar 20, 2026

thanks for the contribution which has been merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants