// Generates new Google Cloud Java client libraries by processing service information and updating the hermetic build configuration. Use this skill when tasked with onboarding a new service or version to the google-cloud-java repository.
| name | new-client-library-generator |
| description | Generates new Google Cloud Java client libraries by processing service information and updating the hermetic build configuration. Use this skill when tasked with onboarding a new service or version to the google-cloud-java repository. |
This skill automates the process of adding a new client library to the google-cloud-java repository using the hermetic build system. It retrieves service information from a Buganizer ticket (which links to a Service YAML file) and runs the configuration script to update generation_config.yaml.
Use the available Buganizer MCP server to fetch the ticket content. The ticket will contain a link to a Service YAML file. Parse this YAML file to extract the fields below.
[!IMPORTANT] Not all fields in the Service YAML file may exist. You must ensure that all Required fields are identified and populated before executing the generation script.
Required:
api_shortname: Unique service identifier (e.g., alloydb).name_pretty: Human-friendly name (e.g., AlloyDB API).proto_path: Versioned path to protos (e.g., google/cloud/alloydb/v1). Must include the version component — root-level paths like google/cloud/alloydb are not supported.product_docs: Product documentation URL (must start with https://).api_description: First sentence of the service summary.Optional:
rest_docs: REST reference documentation URL.rpc_docs: RPC/proto reference documentation URL.library_name: Override the default java-<api_shortname> directory name.distribution_name: Override Maven coordinates (default: com.google.cloud:google-cloud-<api_shortname>).For the field-to-flag mapping, see references/service_yaml_mapping.md (Service YAML fields → script flags).
Before running the script, verify api_shortname is not already in use:
grep "api_shortname: <API_SHORTNAME>" generation_config.yaml
If a conflict exists, determine a unique name or use --library-name to set a distinct directory. See references/generation_guide.md for examples.
Some APIs require non-default Maven coordinates and api_shortname values:
| Proto path prefix | --api-shortname | --distribution-name |
|---|---|---|
google/maps/* | maps-<api_short_name> | com.google.maps:google-maps-<api_short_name> |
google/shopping/* | shopping-<api_short_name> | com.google.shopping:google-shopping-<api_short_name> |
where <api_short_name> is the value from the Service YAML.
If the library does not exist yet, run the script with the gathered information:
python3 generation/new_client_hermetic_build/add-new-client-config.py add-new-library \
--api-shortname="[API_SHORTNAME]" \
--name-pretty="[NAME_PRETTY]" \
--proto-path="[PROTO_PATH]" \
--product-docs="[PRODUCT_DOCS]" \
--api-description="[API_DESCRIPTION]" \
[OPTIONAL_FLAGS]
The script modifies generation_config.yaml and sorts the libraries list alphabetically.
To see all available flags:
python3 generation/new_client_hermetic_build/add-new-client-config.py add-new-library --help
If the client library module already exists and the request is to add a new version, do NOT run the script. Instead, manually add the corresponding proto_path for the new version to the GAPICs list of the existing library entry in generation_config.yaml.
Example entry update:
- api_shortname: myapi
...
GAPICs:
- proto_path: google/cloud/myapi/v1
- proto_path: google/cloud/myapi/v2 # Manually added
After execution or manual update:
generation_config.yaml has a new or updated entry with the correct fields. See references/generation_config_schema.md.proto_path under GAPICs includes a version component (e.g., v1, v1beta, v1alpha).product_documentation starts with https://.After verifying the changes:
git checkout -b "new-library/[API_SHORTNAME]"
git add generation_config.yaml
git commit -m "feat: new module for [API_SHORTNAME]"
Then open a pull request. The Pull Request body must only contain the add-new-library command used.
PR Body Template:
Command used:
python3 generation/new_client_hermetic_build/add-new-client-config.py add-new-library \
--api-shortname="[API_SHORTNAME]" \
--name-pretty="[NAME_PRETTY]" \
--proto-path="[PROTO_PATH]" \
--product-docs="[PRODUCT_DOCS]" \
--api-description="[API_DESCRIPTION]" \
[OPTIONAL_FLAGS]
The hermetic library generation workflow will be triggered automatically upon changes to generation_config.yaml.