Skip to content

Commit 8cfbd86

Browse files
committed
document --disable-blocking exit behavior
Signed-off-by: lelia <2418071+lelia@users.noreply.github.com>
1 parent ce33da6 commit 8cfbd86

2 files changed

Lines changed: 6 additions & 2 deletions

File tree

docs/cli-reference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -305,7 +305,7 @@ The CLI will automatically install `@coana-tech/cli` if not present. Use `--reac
305305
| Parameter | Required | Default | Description |
306306
|:-------------------------|:---------|:--------|:----------------------------------------------------------------------|
307307
| `--ignore-commit-files` | False | False | Ignore commit files |
308-
| `--disable-blocking` | False | False | Disable blocking mode |
308+
| `--disable-blocking` | False | False | Non-blocking CI mode: the CLI always exits **0**, even when blocking alerts are present (including with `--strict-blocking`). Also exits 0 on uncaught runtime errors and Socket API failures, so the job is treated as successful while findings and errors are still logged. Takes precedence over `--strict-blocking`. |
309309
| `--disable-ignore` | False | False | Disable support for `@SocketSecurity ignore` commands in PR comments. When set, alerts cannot be suppressed via comments and ignore instructions are hidden from comment output. |
310310
| `--strict-blocking` | False | False | Fail on ANY security policy violations (blocking severity), not just new ones. Only works in diff mode. See [Strict Blocking Mode](#strict-blocking-mode) for details. |
311311
| `--enable-diff` | False | False | Enable diff mode even when using `--integration api` (forces diff mode without SCM integration) |

socketsecurity/config.py

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -695,7 +695,11 @@ def create_argument_parser() -> argparse.ArgumentParser:
695695
"--disable-blocking",
696696
dest="disable_blocking",
697697
action="store_true",
698-
help="Disable blocking mode"
698+
help=(
699+
"Non-blocking CI mode: always exit 0, even when blocking alerts are present "
700+
"(including with --strict-blocking), on uncaught errors, or on Socket API failures. "
701+
"Findings and errors are still logged. Overrides --strict-blocking."
702+
),
699703
)
700704
advanced_group.add_argument(
701705
"--disable_blocking",

0 commit comments

Comments
 (0)