Skip to content

Commit 67fdebf

Browse files
authored
docs: add a callout about SARIF exit code behavior (#630)
Signed-off-by: William Woodruff <[email protected]>
1 parent a0c9e5d commit 67fdebf

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/usage.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -455,6 +455,21 @@ jobs:
455455
For more inspiration, see `zizmor`'s own [repository workflow scan], as well
456456
as GitHub's example of [running ESLint] as a security workflow.
457457

458+
!!! important
459+
460+
When using `--format sarif`, `zizmor` does not use its
461+
[exit codes](#exit-codes) to signal the presence of findings. As a result,
462+
`zizmor` will always exit with code `0` even if findings are present,
463+
**unless** an internal error occurs during the audit.
464+
465+
As a result of this, the `zizmor.yml` workflow itself will always
466+
succeed, resulting in a green checkmark in GitHub Actions.
467+
This should **not** be confused with a lack of findings.
468+
469+
To prevent a branch from being merged with findings present, you can
470+
use GitHub's rulesets feature. For more information, see
471+
[About code scanning alerts - Pull request check failures for code scanning alerts].
472+
458473
[zizmor package from PyPI]: https://pypi.org/p/zizmor
459474

460475
[SARIF]: https://sarifweb.azurewebsites.net/
@@ -467,6 +482,8 @@ as GitHub's example of [running ESLint] as a security workflow.
467482

468483
[Advanced Security]: https://docs.github.com/en/get-started/learning-about-github/about-github-advanced-security
469484

485+
[About code scanning alerts - Pull request check failures for code scanning alerts]: https://docs.github.com/en/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#pull-request-check-failures-for-code-scanning-alerts
486+
470487
### Use with GitHub Enterprise
471488

472489
`zizmor` supports GitHub instances other than `github.com`.

0 commit comments

Comments
 (0)