Skip to content

chore: update gapic-generator-cloud to 0.52.0 - #36532

Open
suztomo wants to merge 2 commits into
googleapis:mainfrom
suztomo:chore/update-gapic-generator-cloud-0.52.0
Open

chore: update gapic-generator-cloud to 0.52.0#36532
suztomo wants to merge 2 commits into
googleapis:mainfrom
suztomo:chore/update-gapic-generator-cloud-0.52.0

Conversation

@suztomo

@suztomo suztomo commented Sep 4, 2026

Copy link
Copy Markdown
Member

Summary

Updates gapic-generator-cloud to 0.52.0 in librarian.yaml and regenerates libraries with librarian generate -all.

The prefix of this pull request is chore: because this update only improves YARD documentation formatting and internal tooling without introducing any breaking or user-facing changes to the client library interfaces.

Analysis of Code Diffs by Recent gapic-generator-ruby Pull Requests

All generated code diffs in this PR originate from improvements in gapic-generator-ruby merged in the past week (< 1 week) and released in gapic-generator / gapic-generator-cloud 0.52.0 (#1343):

1. Preserving Braces in Code Blocks & Inline Spans (#1337)

  • Merged PR: gapic-generator-ruby#1337 - fix(generator): escape multi-line braces and backtick unknown doc tags in yard formatting
  • Root Cause & Fix: Previously, FormattingUtils.format_doc_lines did not track Markdown fenced code blocks (```) or multiline inline code spans ( ...` `). When braces appeared inside code snippets or JSON examples, the generator incorrectly escaped them as `{...}`. In PR Test code examples in the BigQuery guide #1337, `format_doc_lines` now maintains block state (`in_fence` and `in_code_span`) and preserves braces untouched inside code blocks and inline spans.
  • Diffs in this PR:
    • google-apps-chat-v1: Restores unescaped braces in Markdown fenced code blocks (e.g. user.name = "users/{user}" and emoji.custom_emoji.uid = "{uid}" instead of users/\{user}).
    • google-cloud-ai_platform-v1: In inline code spans, braces in resource name templates are preserved without escapes (e.g. projects/{project}/locations/{location}/featurestores/{featurestore}/entityTypes/{entityType}).
    • google-cloud-dataqna-v1alpha: In annotated_string.rb and auto_suggestion_service.rb, code examples now render {DIMENSION, 4, 12} and {type: TEXT, ...} without unnecessary backslash escapes.
    • Similar code-block brace cleanups occur across google-cloud-bigquery-analytics_hub-v1, google-cloud-pubsub-v1, google-cloud-chronicle-v1, google-cloud-network_services-v1, google-cloud-oracle_database-v1, google-iam-v1beta, google-maps-route_optimization-v1, and google-shopping-merchant-accounts-v1*.

2. Escaping Multiline Braces in Prose (#1337)

  • Merged PR: gapic-generator-ruby#1337
  • Root Cause & Fix: YARD interprets {...} in prose as link or tag directives. When literal braces span across lines (such as multiline JSON examples or number ranges), YARD fails to parse them, causing build warnings and doc errors. PR Test code examples in the BigQuery guide #1337 added escape_prose_braces, escaping unescaped { outside backtick spans as \{.
  • Diffs in this PR:
    • google-apps-chat-v1/proto_docs/google/apps/card/v1/card.rb: Escapes multiline range syntax Choose from \{100, 200, 300, 400, 500, 600, 700}.
    • google-cloud-agent_registry-v1/proto_docs/google/cloud/agentregistry/v1/agent.rb & mcp_server.rb: Escapes multiline JSON examples in prose: \{"framework": ...} and \{"principal": ...}.
    • google-cloud-ai_platform-v1/proto_docs/google/cloud/aiplatform/v1/evaluation_service.rb: Escapes multiline parameter example e.g. \{"rouge_type": "rougeL"}.
    • google-cloud-cloud_security_compliance-v1/proto_docs/.../deployment.rb: Escapes multiline JSON \{"key": ...}.

3. Sanitizing Unknown Doc Tags (#1337)

  • Merged PR: gapic-generator-ruby#1337
  • Root Cause & Fix: Words starting with @ in proto comments (e.g. @all or @mentions) were interpreted by YARD as doc tag directives, producing @unknown tag warnings. PR Test code examples in the BigQuery guide #1337 introduced sanitize_prose_tags to wrap any tag not recognized by YARD in backticks (e.g. `@all`).
  • Diffs in this PR:
    • google-apps-chat-v1/proto_docs/google/chat/v1/space.rb: Sanitizes @all -> `@all`.
    • google-apps-chat-v1/proto_docs/google/chat/v1/space_notification_setting.rb: Sanitizes @mentions -> `@mentions`.

4. Other Generator Features in 0.52.0 (#1340, #1342)

  • gapic-generator-ruby#1340: Automatically rejoins split doc URLs across newlines (b/153077040) and strips dangling cross-reference links for messages absent from proto docs (b/158466893), which unblocks onboarding google-cloud-automl-v1.
  • gapic-generator-ruby#1342: Adds generator support for ruby-cloud-renamed-from parameter, which unblocks onboarding renamed wrapper gems (google-cloud-run-client and google-iam-client).

Verification

  • librarian install: Successfully installed gapic-generator-cloud 0.52.0 and dependencies.
  • librarian generate -all: Ran cleanly across all configured gems.
  • Local CI verification across representative modified gems (google-apps-chat-v1, google-cloud-dialogflow-v2, google-cloud-oracle_database-v1, google-cloud-bigtable-v2):
    • Unit tests: 818 runs, 0 failures, 0 errors, 0 skips (toys ci --test)
    • RuboCop: 0 offenses (toys ci --rubocop)
    • YARD documentation generation: 0 warnings, 0 errors (toys ci --yard)

@suztomo
suztomo marked this pull request as ready for review September 4, 2026 21:05
@suztomo
suztomo requested review from a team and yoshi-approver as code owners September 4, 2026 21:05
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.

3 participants