Skip to content

Commit cb3d21c

Browse files
committed
chore(codeql): add paths-ignore for vendored bundles, shadow src, audit tools
Three categories of code surfacing CodeQL alerts that aren't appropriate to fix in-tree: - book/quarto/tools/scripts/socratiQ/collaborative-widget-bridge.{js,umd.cjs}: minified upstream socratiQ widget bundle. Alerts (XSS, prototype pollution, tainted format string, insecure randomness, clear-text storage) live in vendored third-party code; report upstream rather than patch a build artifact. - socratiq/src_shadow/**: shadow copy of socratiq client source for the shadow-DOM rendering path, parallel to socratiq/js/. Not part of the live web surface. - tools/audit/**: local audit/maintenance scripts that operate on the user's own Quarto build output. Regex HTML strip is intentional for speed and safe given trusted input. Default-setup CodeQL picks up .github/codeql/codeql-config.yml on next weekly scan; pre-existing alerts on these paths still need manual dismissal in the Security tab.
1 parent a8acabd commit cb3d21c

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

.github/codeql/codeql-config.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: "MLSysBook CodeQL config"
2+
3+
# Paths excluded from analysis. Each entry below is code that operates on
4+
# trusted local artifacts or is vendored from upstream — out of scope for
5+
# the web-facing security analyses CodeQL applies by default.
6+
paths-ignore:
7+
# Vendored third-party widget bundle (minified output from upstream
8+
# socratiQ collaborative-widget-bridge build). Not hand-edited; alerts
9+
# here should be reported upstream, not patched in-tree.
10+
- "book/quarto/tools/scripts/socratiQ/collaborative-widget-bridge.js"
11+
- "book/quarto/tools/scripts/socratiQ/collaborative-widget-bridge.umd.cjs"
12+
13+
# Shadow copy of socratiq client source — parallel to socratiq/js/, kept
14+
# for the shadow-DOM rendering path. Not part of the live web surface.
15+
- "socratiq/src_shadow/**"
16+
17+
# Local audit/maintenance scripts that operate on the user's own Quarto
18+
# build output. Not web-facing; regex-based HTML strip is intentional
19+
# for speed and is safe given trusted input.
20+
- "tools/audit/**"

0 commit comments

Comments
 (0)