Backport to branch(3) : Deprecate --log-success argument and introduce new replacement option --enable-log-success

[feeblefakie]

This is an automated backport of the following:

• Original PR: Deprecate --log-success argument and introduce new replacement option --enable-log-success #3117
• Backported commit: d269d9d

Please merge this PR after all checks have passed.

[gemini-code-assist]

Summary of Changes

Hello @feeblefakie, 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 backports a significant change to the data loader's command-line interface, deprecating the --log-success argument in favor of a more explicit --enable-log-success option. The update ensures that the application's command-line arguments are clearer and more consistent, while also providing robust validation to prevent misconfiguration. It includes logic to seamlessly transition users from the old argument to the new one, maintaining backward compatibility for existing scripts and configurations.

Highlights

• Argument Deprecation: The --log-success command-line argument has been deprecated and replaced with --enable-log-success for improved clarity and consistency in the data loader's interface.
• Validation for Option Usage: Validation logic has been introduced to prevent users from simultaneously specifying both the deprecated --log-success and the new --enable-log-success options, ensuring unambiguous configuration.
• Backward Compatibility: Backward compatibility is maintained by automatically mapping the value of the deprecated --log-success option to the new --enable-log-success option if the deprecated one is used, facilitating a smooth transition.
• Enhanced Test Coverage: New unit tests have been added to comprehensively cover the deprecation logic, the interaction between the old and new options, and the correct parsing behavior of the new --enable-log-success option.

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 effectively deprecates the --log-success argument in favor of a more descriptive --enable-log-success option. The implementation correctly handles backward compatibility and adds validation to prevent conflicts between the old and new options. The accompanying tests are a good addition to verify the new behavior. I've included a couple of minor suggestions to enhance the new tests for better consistency and robustness. Overall, the changes are well-executed and improve the command-line interface.