Deprecate --log-success argument and introduce new replacement option --enable-log-success

[inv-jishnu]

Description

This PR deprecates an existing CLI argument --log-success and introduces a new one --enable-log-success to improve clarity and consistency in command-line usage. The change ensures backward compatibility while guiding users toward the updated argument name.

The change is applied based on PR review feedback from Yamada-san to make the naming more consistent.

Related issues and/or PRs

NA

Changes made

Deprecated:

• --log-success— now marked as deprecated. A warning message is shown when used.

Added:

• --enable-log-success — replaces the deprecated argument

I have also added a unit test to confirm old argument can still be used and throws an error when both arguments are used.

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

• I have commented my code, particularly in hard-to-understand areas.
• I have updated the documentation to reflect the changes.
• I have considered whether similar issues could occur in other products, components, or modules if this PR is for bug fixes.
• Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
• Tests (unit, integration, etc.) have been added for the changes.
• My changes generate no new warnings.
• Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

NA

Release notes

Deprecated --log-success argument and introduced a new replacement option --enable-log-success

[gemini-code-assist]

Summary of Changes

Hello @inv-jishnu, 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 refactors the command-line interface for the data import command by deprecating the --log-success argument in favor of a more explicit --enable-log-success. This change enhances clarity and consistency in CLI usage while maintaining full backward compatibility for existing implementations. It also includes robust validation and testing to ensure a smooth transition and prevent misconfigurations.

Highlights

• Argument Deprecation: The --log-success CLI argument has been deprecated to improve clarity and consistency in command-line usage.
• New Argument Introduction: A new argument, --enable-log-success, has been introduced as the replacement for the deprecated option, providing a more explicit name.
• Backward Compatibility: The deprecated --log-success argument is still supported, ensuring that existing scripts and commands continue to function without immediate changes.
• Usage Conflict Prevention: Validation has been added to detect and prevent simultaneous use of both the deprecated --log-success and the new --enable-log-success arguments, throwing an error if both are specified.
• Unit Testing: Comprehensive unit tests have been added to verify the correct behavior of both the backward compatibility for the deprecated argument and the error handling for conflicting argument usage.

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 correctly deprecates the --log-success argument and introduces --enable-log-success as a replacement. The changes are well-implemented, ensuring backward compatibility and adding validation to prevent misuse. The new unit tests effectively cover the new logic for both successful deprecation handling and error cases. I've suggested a couple of minor improvements to the new tests to make them more focused and maintainable by removing unnecessary arguments.

[komamitsu]

LGTM! 👍

[brfrn169]

LGTM! Thank you!

[feeblefakie]

LGTM! Thank you!

[ypeckstadt]

LGTM. Thank you.

[Torch3333]

LGTM, thank you!

[ypeckstadt]

@inv-jishnu I added some extra unit tests here to make sure that the flag works as expected without setting a true or false value.