Issue #4231: jib cli: add doc about jvm options

[scrat98]

Closes #4231

[gemini-code-assist]

Summary of Changes

Hello @scrat98, I'm Gemini Code Assist¹! 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 addresses issue #4231 by enhancing the jib-cli/README.md file. It provides users with clear guidance on how to configure Java Virtual Machine (JVM) options for the Jib CLI, which is a Java-based application. This enhancement clarifies the process for passing runtime settings, such as proxy configurations, ensuring better usability and troubleshooting for advanced scenarios.

Highlights

• Jib CLI JVM Options Documentation: A new section has been added to the jib-cli/README.md to document how to configure JVM options for the Jib CLI.
• Environment Variables for JVM Options: The documentation clarifies that JIB_OPTS or JAVA_OPTS environment variables can be used to pass JVM options to the Jib CLI process.
• Proxy Configuration Example: The new section highlights that configuring proxies is a common use case for these JVM options, linking to the existing proxy configuration FAQ.

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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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

1. 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. ↩

[gemini-code-assist]

Code Review

This pull request adds documentation for configuring JVM options for the Jib CLI. The change is good, but I've suggested an improvement to make the documentation clearer for CLI users by avoiding a link to a potentially confusing FAQ section and instead linking to the canonical Java documentation.

[gemini-code-assist]

The linked FAQ section on proxy configuration is written for the Jib Maven/Gradle plugins and talks about configuring the build tool. This might be confusing for a Jib CLI user.

To improve clarity, I suggest removing the link to the FAQ, providing examples of the properties, and linking to the official Java documentation for networking properties instead.

Suggested change

	This is commonly used to configure settings like a proxy by passing standard Java networking properties, as described in the [proxy configuration FAQ](../docs/faq.md#how-do-i-configure-a-proxy).
	This is commonly used to configure settings like a proxy by passing standard Java networking properties (e.g., `https.proxyHost` and `https.proxyPort`). For a full list of properties, see the [Java Networking and Proxies documentation](https://docs.oracle.com/javase/8/docs/technotes/guides/net/proxies.html).