Merge pull request #1003 from GitGuardian/plalanne/-/fix-with-incident-details-option

Fix with-incident-details option

Author: agateau-gg

changelog.d/20241107_194448_pierrelalanne_fix_with_incident_details_option.md

@@ -0,0 +1,41 @@
+<!--
+A new scriv changelog fragment.
+
+Uncomment the section that is right (remove the HTML comment wrapper).
+-->
+
+<!--
+### Removed
+
+- A bullet item for the Removed category.
+
+-->
+<!--
+### Added
+
+- A bullet item for the Added category.
+
+-->
+<!--
+### Changed
+
+- A bullet item for the Changed category.
+
+-->
+<!--
+### Deprecated
+
+- A bullet item for the Deprecated category.
+
+-->
+
+### Fixed
+
+- We add a default value None to the click option `with-incident-details` to fix the behavior of the option.
+<!--
+
+### Security
+
+- A bullet item for the Security category.
+
+-->

ggshield/cmd/secret/scan/secret_scan_common_options.py

@@ -95,6 +95,10 @@ def _exclude_callback(
 _ignore_known_secrets_option = click.option(
     "--ignore-known-secrets",
     is_flag=True,
+    # The default value **must** be set to None.
+    # Each command or subcommand calls create_config_callback to gather option values.
+    # If the option is placed early in the command line, the value may be overridden
+    # later on with False if no default is defined.
     default=None,
     help="Ignore secrets already known by GitGuardian dashboard.",
     callback=create_config_callback("secret", "ignore_known_secrets"),
@@ -124,6 +128,11 @@ def _banlist_detectors_callback(
 _with_incident_details_option = click.option(
     "--with-incident-details",
     is_flag=True,
+    # The default value **must** be set to None.
+    # Each command or subcommand calls create_config_callback to gather option values.
+    # If the option is placed early in the command line, the value may be overridden
+    # later on with False if no default is defined.
+    default=None,
     help="Display full details about the dashboard incident if one is found (JSON and SARIF formats only).",
     callback=create_config_callback("secret", "with_incident_details"),
 )