-
Notifications
You must be signed in to change notification settings - Fork 1.6k
chore: librarian onboard pull request: 20251205T215603Z #14953
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Summary of ChangesHello @Linchin, 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 automates the onboarding of the new Python client library for the Google Cloud Maintenance API. It integrates the library into the existing repository structure by adding necessary configuration, generating client code, setting up documentation, and establishing development and testing infrastructure, ensuring the new API is fully supported and ready for use. 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 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 counter productive. 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. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this 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 onboards the new google-cloud-maintenance client library. The changes are mostly auto-generated boilerplate. I've found a few typos in user-facing documentation and examples, and a critical issue with the package name in setup.py that needs to be addressed.
|
|
||
| package_root = os.path.abspath(os.path.dirname(__file__)) | ||
|
|
||
| name = "google-cloud-maintenance-api" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The package name should be google-cloud-maintenance, not google-cloud-maintenance-api. The -api suffix is typically reserved for the proto-only packages. The directory name and .repo-metadata.json both use google-cloud-maintenance.
| name = "google-cloud-maintenance-api" | |
| name = "google-cloud-maintenance" |
| - ``resource.resourceName=~"*/instance-20241212-211259"`` | ||
| - ``maintenanceStartTime>"2000-10-11T20:44:51Z"`` | ||
| - ``state="SCHEDULED" OR resource.type="compute.googleapis.com/Instance"`` | ||
| - ``maintenance.maitenanceName="eb3b709c-9ca1-5472-9fb6-800a3849eda1" AND maintenanceCompleteTime>"2000-10-11T20:44:51Z"`` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a typo in the filter example for maintenance.maintenanceName. "maitenanceName" should be "maintenanceName". An incorrect example could cause user confusion and errors.
| - ``maintenance.maitenanceName="eb3b709c-9ca1-5472-9fb6-800a3849eda1" AND maintenanceCompleteTime>"2000-10-11T20:44:51Z"`` | |
| - ``maintenance.maintenanceName="eb3b709c-9ca1-5472-9fb6-800a3849eda1" AND maintenanceCompleteTime>"2000-10-11T20:44:51Z"`` |
| { | ||
| "name": "google-cloud-maintenance", | ||
| "name_pretty": "Maintenance API", | ||
| "api_description": "The Maintenance API provides a centralized view of planned disruptive\nmaintenance events across supported Google Cloud products. It offers users\nvisibility into upcoming, ongoing, and completed maintenance, along with\ncontrols to manage certain maintenance activities, such as mainteance\nwindows, rescheduling, and on-demand updates.", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a typo in the api_description. "mainteance" should be "maintenance".
| "api_description": "The Maintenance API provides a centralized view of planned disruptive\nmaintenance events across supported Google Cloud products. It offers users\nvisibility into upcoming, ongoing, and completed maintenance, along with\ncontrols to manage certain maintenance activities, such as mainteance\nwindows, rescheduling, and on-demand updates.", | |
| "api_description": "The Maintenance API provides a centralized view of planned disruptive\nmaintenance events across supported Google Cloud products. It offers users\nvisibility into upcoming, ongoing, and completed maintenance, along with\ncontrols to manage certain maintenance activities, such as maintenance\nwindows, rescheduling, and on-demand updates.", |
| controls to manage certain maintenance activities, such as mainteance | ||
| windows, rescheduling, and on-demand updates. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a typo in the description. "mainteance" should be "maintenance".
| controls to manage certain maintenance activities, such as mainteance | |
| windows, rescheduling, and on-demand updates. | |
| controls to manage certain maintenance activities, such as maintenance | |
| windows, rescheduling, and on-demand updates. |
| controls to manage certain maintenance activities, such as mainteance | ||
| windows, rescheduling, and on-demand updates. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's a typo in the description. "mainteance" should be "maintenance". This file appears to be a copy of the root README, so the fix should be applied here as well.
| controls to manage certain maintenance activities, such as mainteance | |
| windows, rescheduling, and on-demand updates. | |
| controls to manage certain maintenance activities, such as maintenance | |
| windows, rescheduling, and on-demand updates. |
|
This package was created as |
PR created by the Librarian CLI to onboard a new Cloud Client Library.
BEGIN_COMMIT
feat: onboard a new library
PiperOrigin-RevId: 840720260
Library-IDs: google-cloud-maintenance
END_COMMIT
Librarian Version: v0.7.0
Language Image: us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/python-librarian-generator@sha256:72e9b62c0f8f3799651ee62d777a2905f5b72ff19ea46f2e7b7d682d7d1e9414