-
Notifications
You must be signed in to change notification settings - Fork 1.6k
chore(librarian): temporarily add gdb for remote debugging #15501
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 temporary modification to the generator's Dockerfile by including 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 adds the gdb debugger to the generator's Docker image to facilitate remote debugging of an issue. The change is clearly marked as temporary with a corresponding TODO and issue link. My review includes a suggestion to consider a multi-stage Docker build for such scenarios in the future. This would keep the primary image lean and secure by isolating debugging tools into a separate, on-demand build stage. While the current approach is acceptable for a short-term fix, adopting a multi-stage pattern is a recommended practice for better image management.
| # TODO(https://github.com/googleapis/google-cloud-python/issues/14992): Remove gdb | ||
| # Once this bug is fixed. | ||
| # Temporarily add gdb to assist with remote debugging for issue 14992. | ||
| gdb \ |
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.
While adding gdb is understandable for temporary debugging, committing it to the main Dockerfile increases the image size and potential attack surface. A better practice is to use a multi-stage build to isolate debugging tools.
You could define a separate debug stage that builds upon the main image and only adds gdb. This keeps the default image lean and secure, while allowing a debug-enabled version to be built on demand (e.g., docker build --target debug ...).
Example of a debug stage:
FROM builder as debug
RUN apt-get update && apt-get install -y --no-install-recommends gdb && rm -rf /var/lib/apt/lists/*Since this is a temporary change with a TODO, it's acceptable. However, please consider this pattern for future needs to maintain a clean base image.
|
|
Pull request was closed
Towards #14992