Skip to content

docs(internal/surfer/gcloud/provider): generate gcloud.yaml schema doc#5473

Merged
julieqiu merged 1 commit intogoogleapis:mainfrom
julieqiu:gcloud-yaml-schema-doc
Apr 20, 2026
Merged

docs(internal/surfer/gcloud/provider): generate gcloud.yaml schema doc#5473
julieqiu merged 1 commit intogoogleapis:mainfrom
julieqiu:gcloud-yaml-schema-doc

Conversation

@julieqiu
Copy link
Copy Markdown
Member

@julieqiu julieqiu commented Apr 20, 2026

Generate documentation for the gcloud.yaml schema using go generate and the config_doc_generate tool.

A go:generate directive in provider/config.go now invokes the existing
config_doc_generate tool to produce doc/gcloud/gcloud-yaml-schema.md
from the Config struct. This follows the same pattern already used to
document librarian.yaml and the API allowlist.
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a gcloud.yaml schema documentation file and adds a go:generate directive to the provider package to automate its generation. The generated documentation contains a redundant and poorly formatted HelpText section at the end, which likely stems from an improperly tagged or duplicate struct in the source code.

Comment thread doc/gcloud/gcloud-yaml-schema.md
@julieqiu julieqiu marked this pull request as ready for review April 20, 2026 02:38
@julieqiu julieqiu requested review from a team as code owners April 20, 2026 02:38
@julieqiu julieqiu enabled auto-merge (squash) April 20, 2026 02:38
@julieqiu julieqiu merged commit 962f7b2 into googleapis:main Apr 20, 2026
21 of 22 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants