-
Notifications
You must be signed in to change notification settings - Fork 517
Document RunConfig interface in README #454
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
base: main
Are you sure you want to change the base?
Conversation
Added RunConfig interface definition to README.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Summary of ChangesHello @galaxys10pluss, 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 enhances the project's documentation by formally defining 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 aims to add documentation for the RunConfig interface to the README.md file. However, the added content appears to be misplaced and incorrectly formatted, which disrupts the rendering of the document's main title. Additionally, this interface is already documented within the same file. My review includes a comment suggesting the removal of this redundant and malformed block to correct the formatting and structure of the README.
| interface RunConfig { | ||
| runCommand: string; | ||
| environmentVariables?: EnvVarConfig[]; | ||
| concurrency?: number; | ||
| cpu?: number; | ||
| memoryMiB?: number; | ||
| minInstances?: number; | ||
| maxInstances?: number; | ||
| }# App Hosting adapters |
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.
This added block appears to be a mistake. It duplicates the RunConfig interface definition, which is already documented further down in this file under the ### RunConfig section. Additionally, the content is not wrapped in a markdown code block and the closing brace is on the same line as the main document title, which will cause formatting issues. This block should be removed to avoid duplication and fix the document's rendering.
| interface RunConfig { | |
| runCommand: string; | |
| environmentVariables?: EnvVarConfig[]; | |
| concurrency?: number; | |
| cpu?: number; | |
| memoryMiB?: number; | |
| minInstances?: number; | |
| maxInstances?: number; | |
| }# App Hosting adapters | |
| # App Hosting adapters |
…ended#454) * fix: use ENTRYPOINT and CMD for proper argument handling - Change from CMD to ENTRYPOINT + CMD pattern for better Docker practices - ENTRYPOINT sets the executable that always runs - CMD provides default arguments that can be overridden - This allows container runtimes to properly append additional arguments - Fixes issues with argument passing in container orchestration tools Before: CMD ["./github-mcp-server", "stdio"] After: ENTRYPOINT ["./github-mcp-server"] + CMD ["stdio"] * address review feedback: use absolute path and improve comments
Added RunConfig interface definition to README.