Skip to content

docs: correct the stale --error comment in the semgrep job #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arootroatch merged 1 commit into from
Jul 28, 2026
Merged

docs: correct the stale --error comment in the semgrep job #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 14 additions & 5 deletions .github/workflows/security.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,11 +295,20 @@ jobs:
# rule enumerates them and spec-fixtures/ exercises more than one spelling —
# see bin/test-rules.sh, which fails if that stops working.
#
# semgrep ALWAYS runs with --error, so any finding turns this job red and
# stays visible — its "Blocking" label is a policy tag, NOT an exit code, so
# --error is what actually makes `semgrep scan` exit non-zero. continue-on-
# error decides only whether that red BLOCKS the build: advisory (default)
# surfaces it without blocking; semgrep-blocking: true fails the build.
# Two independent gates, easy to conflate:
#
# 1. WHICH findings turn this job red — decided by bin/report-sarif.sh,
# which exits 1 only on error-level results. semgrep is deliberately NOT
# run with --error: that gates on ANY finding regardless of severity,
# which would make cc-path-traversal, cc-generic-catch and
# cc-clojure-xml-xxe block builds despite being WARNING precisely so they
# do not. Findings suppressed in source with nosemgrep are excluded too.
#
# 2. Whether a red job BLOCKS the caller — decided by continue-on-error
# below. Advisory by default; semgrep-blocking: true propagates it.
#
# semgrep's own "Blocking" label in its console summary is its policy tag and
# has no bearing on either gate.
continue-on-error: ${{ !inputs.semgrep-blocking }}
container:
# Digest-pinned, not :latest. semgrep is now the ONLY Clojure detection
Expand Down
13 changes: 13 additions & 0 deletions bin/test-report-sarif.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,5 +66,18 @@ out="$(bash "${REPORT}" "${WORK}/absent.sarif" 2>&1)"; rc=$?
check "missing SARIF fails" "$rc" "1"
check "missing SARIF explains why" "$(echo "$out" | grep -c 'did not complete')" "1"

# --- wiring: the workflow must not re-add semgrep's --error ------------------
# --error makes semgrep exit non-zero on ANY finding regardless of severity.
# Under `set -e` that kills the step before report-sarif.sh runs, which would
# silently (a) make the WARNING rules block builds, contradicting the README, and
# (b) delete the findings table. Cheap to re-add by accident, so pin it.
WF="${ROOT}/.github/workflows/security.yml"
if [ -f "$WF" ]; then
check "semgrep is not invoked with --error" \
"$(grep -cE '^\s+args=\(scan.*--error' "$WF")" "0"
check "the reporter is actually called" \
"$(grep -c 'report-sarif.sh semgrep.sarif' "$WF")" "1"
fi

echo "report-sarif tests: ${pass} passed, ${fail} failed"
[ "${fail}" -eq 0 ]
Loading