Repository navigation
feat(catalog): add catalog-gen for blueprint catalog and examples README table - #6481
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request implements a robust, deterministic system for maintaining a blueprint and module catalog. By replacing the previous proof-of-concept with a structured Go generator, the repository now ensures that documentation and machine-readable references remain consistent with the actual infrastructure definitions. This change improves maintainability and provides better visibility into the available blueprints and their interdependencies. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize the Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counterproductive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces an automated catalog generator tool (catalog-gen) in Go that scans blueprints and modules to produce a machine-readable catalog and updates the summary table in examples/README.md. It also integrates this tool as a pre-commit hook and updates the blueprint assistant skill documentation. The review feedback highlights two important issues in pkg/catalog/catalog.go: a potential runtime panic when assigning to a nil map if a blueprint has no variables, and a UTF-8 safety issue where slicing description strings by byte index could cut multi-byte characters in half.
a618e25 to
cb93b06
Compare
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request introduces an automated catalog generator tool (catalog-gen) along with a pre-commit hook to maintain a machine-readable blueprint and module wiring catalog and update the summary table in examples/README.md. It also updates the AI agent guidelines in AGENTS.md and SKILL.md to clarify blueprint customization rules. Feedback on the new Go code highlights a potential runtime panic in catalog.go if a blueprint has no variables, as well as a potential UTF-8 slicing issue when truncating description strings by byte index instead of rune index.
1ecccdd to
7305f2d
Compare
…nt vars Use folder README for gke-consumption-options descriptions instead of top-level README
86afe84 to
3e81018
Compare
4c56291
into
GoogleCloudPlatform:develop
Summary
Implements Full Blueprint Catalog & Docs Generator for the Guardrailing Agents effort, replacing the POC starter starter catalog introduced in #6458 with a deterministic Go generator (
pkg/catalog+tools/catalog-gen) that indexes all blueprints and modules across the repository and keeps documentation in sync via.pre-commit-config.yaml.Changes
pkg/catalog&tools/catalog-gen: Scans blueprints inexamples/andcommunity/examples/and modules inmodules/andcommunity/modules/(filtering out auto-injected global vars and pass-through echo outputs). Includes unit tests (pkg/catalog/catalog_test.go).skills/cluster-blueprint-assistant/references/catalog.yaml&SKILL.md: Full generated catalog and updated skill instructions.examples/README.md: Auto-generated blueprint summary table between<!-- BEGIN_BLUEPRINT_CATALOG -->and<!-- END_BLUEPRINT_CATALOG -->..pre-commit-config.yaml: Addscatalog-genhook to keepcatalog.yamlandexamples/README.mdin sync.