-
Notifications
You must be signed in to change notification settings - Fork 34
Proxy-friendly version of install-docker-repository #654
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
Previously the script would not work in some complex proxy environment. With this change, it is possible to have proxy set in http_proxy environment variable.
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.
Summary of Changes
Hello @arnaudrichard, 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 significantly enhances the install-docker-repository
script by introducing full compatibility with environments that rely on an https_proxy
. The core changes involve updating network requests to properly leverage proxy settings, thereby resolving previous issues where the script would fail to connect or download resources in such configurations.
Highlights
- Proxy Support: The script now properly utilizes the
https_proxy
environment variable for all network operations, enabling it to function correctly in proxy-configured environments. - Network Reachability Check Improvement: The method for verifying
download.docker.com
reachability has been updated. It now usescurl
instead of a raw TCP connection, making the check more robust, secure (using HTTPS), and proxy-aware. - GPG Key Download Proxy Compatibility: The
curl
command used to fetch the Docker GPG key (docker.asc
) has been modified to respect thehttps_proxy
environment variable, ensuring successful key retrieval in proxy environments. - Domain Name Correction: Minor text updates were made to consistently refer to
download.docker.com
instead ofdocker.download.com
in print statements and comments.
Using Gemini Code Assist
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
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 .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and 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 to provide feedback.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
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 introduces proxy support for the Docker repository installation script, which is a valuable enhancement for users in corporate environments. The changes correctly use curl
with proxy settings from the https_proxy
environment variable. My review focuses on improving code quality with a few minor suggestions: fixing typos in user-facing messages, modernizing a shell command for better performance, and a recommendation to reduce code duplication for better maintainability.
else | ||
echo "The docker.download.com is unreachable for try $i" | ||
echo "The download.docker.com is unreachable for try $i" | ||
sleep $(expr $i \* 2) |
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 better performance and adherence to modern shell scripting practices, it's recommended to use arithmetic expansion $((...))
instead of the external expr
command1. This avoids forking a new process for a simple calculation.
Style Guide References
sleep $(expr $i \* 2) | |
sleep $((i * 2)) |
Footnotes
-
The Google Shell Style Guide recommends using
$(())
for arithmetic operations over theexpr
command for efficiency and simplicity. ↩
sudo apt-get install ca-certificates curl -y | ||
sudo install -m 0755 -d /etc/apt/keyrings | ||
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc | ||
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc ${https_proxy+--proxy $https_proxy} |
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 proxy logic ${https_proxy+--proxy $https_proxy}
is now used in two places (here and in the reachability check loop). To improve maintainability and avoid repetition, consider defining a variable for the proxy options at the beginning of the script and reusing it.
For example:
# At the top of the script
PROXY_CURL_OPTS=""
if [ -n "$https_proxy" ]; then
PROXY_CURL_OPTS="--proxy $https_proxy"
fi
# ... then use it in curl commands
sudo curl ... $PROXY_CURL_OPTS
This makes the code cleaner and easier to update if more curl
commands are added in the future.
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Previously the script would not work in some proxy environments.
With this change, it is possible to have proxy set in "https_proxy" environment variable.