-
Notifications
You must be signed in to change notification settings - Fork 31
[Deployment] Small fix to the staging script to ensure upstream is set #136
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
Summary of ChangesHello @gmechali, 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 small but significant fix to the staging script, primarily focusing on improving the robustness and user guidance during the deployment process. It refines how shell commands are executed by allowing more flexible error handling and specifically addresses potential issues with pushing Git tags to the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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 improves the staging script by ensuring the upstream git remote is used and providing a much better error message if it's not configured. The changes are logical and directly address the goal of the PR. I have one suggestion to improve the security of the script by avoiding shell=True in subprocess calls, which is a general best practice.
| def run_command(cmd: str, *, capture: bool = True, check: bool = True) -> str | int: | ||
| try: | ||
| if capture: | ||
| return subprocess.check_output(cmd, shell=True).decode().strip() # noqa: S602 | ||
| return subprocess.check_call(cmd, shell=True) # noqa: S602 | ||
| except subprocess.CalledProcessError as e: | ||
| if not check: | ||
| raise e | ||
| print(f"Error running command: {cmd}") | ||
| sys.exit(e.returncode) |
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.
Using shell=True with subprocess can introduce a security risk of command injection if the command string is crafted from external input. While the inputs in this script appear to be controlled, it's a security best practice to avoid shell=True. You can achieve this by passing command arguments as a list. The shlex.split() function can be used to safely parse the command string. This also allows removing the # noqa: S602 suppressions.
I've included import shlex inside the function for a self-contained suggestion, but it would be best to move it to the top of the file with other imports.
| def run_command(cmd: str, *, capture: bool = True, check: bool = True) -> str | int: | |
| try: | |
| if capture: | |
| return subprocess.check_output(cmd, shell=True).decode().strip() # noqa: S602 | |
| return subprocess.check_call(cmd, shell=True) # noqa: S602 | |
| except subprocess.CalledProcessError as e: | |
| if not check: | |
| raise e | |
| print(f"Error running command: {cmd}") | |
| sys.exit(e.returncode) | |
| def run_command(cmd: str, *, capture: bool = True, check: bool = True) -> str | int: | |
| import shlex | |
| try: | |
| cmd_args = shlex.split(cmd) | |
| if capture: | |
| return subprocess.check_output(cmd_args).decode().strip() | |
| return subprocess.check_call(cmd_args) | |
| except subprocess.CalledProcessError as e: | |
| if not check: | |
| raise e | |
| print(f"Error running command: {cmd}") | |
| sys.exit(e.returncode) |
No description provided.