-
Notifications
You must be signed in to change notification settings - Fork 1.6k
chore(librarian): Create package changelog if not present #14963
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 @parthea, 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 introduces a crucial fix to the 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 addresses an issue where CHANGELOG.md was being overwritten when adding a new API version to an existing library. The fix correctly checks if the library directory exists before creating a new changelog, which effectively prevents this issue. The logic is sound. I've included one suggestion to use pathlib more idiomatically for path construction, which will improve code clarity and robustness.
| path_to_library = f"packages/{library_id}" if is_mono_repo else "." | ||
| if not Path(f"{repo}/{path_to_library}").exists(): |
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.
For improved readability and cross-platform compatibility, it's better to use pathlib's / operator for joining path components rather than f-string formatting. This is the idiomatic way to work with pathlib and avoids potential issues with path separators.
| path_to_library = f"packages/{library_id}" if is_mono_repo else "." | |
| if not Path(f"{repo}/{path_to_library}").exists(): | |
| path_to_library_str = f"packages/{library_id}" if is_mono_repo else "." | |
| if not (Path(repo) / path_to_library_str).exists(): |
When adding a new API version to an existing library, the contents of the existing package level
CHANGELOG.mdfile is removed. The issue is that a new changelog is created unconditionally here:google-cloud-python/.generator/cli.py
Line 295 in c7696a6
As an example, the command below adds the client library code for
google/cloud/maintenance/api/v1to an existing package google-cloud-maintenance-apiAfter running the command locally, see that the contents of this CHANGELOG.md is gone. See below
With the fix in this PR, a package level changelog will only be created if it is not present. An existing changelog will remain untouched.