Skip to content

Commit 8b9fbbb

Browse files
fix(ci): adopt canonical hypatia-scan.yml (env.HOME/scanner-layout + Comment-step gate) (#16)
1 parent 3ff5cee commit 8b9fbbb

1 file changed

Lines changed: 94 additions & 19 deletions

File tree

.github/workflows/hypatia-scan.yml

Lines changed: 94 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,26 @@ on:
1010
schedule:
1111
- cron: '0 0 * * 0' # Weekly on Sunday
1212
workflow_dispatch:
13-
14-
permissions: read-all
13+
# Estate guardrail: cancel superseded runs so re-pushes don't pile up
14+
# queued runs across the estate. Safe here because this workflow only
15+
# performs read-only checks/lint/test/scan with no publish or mutation.
16+
concurrency:
17+
group: ${{ github.workflow }}-${{ github.ref }}
18+
cancel-in-progress: true
19+
20+
permissions:
21+
contents: read
22+
# security-events: read lets the built-in GITHUB_TOKEN query this
23+
# repo's own Dependabot alerts via the Hypatia DependabotAlerts rule
24+
# (DA001-DA004). Without this, `scan_from_path` gets HTTP 403 and
25+
# the rule silently returns no findings.
26+
# See 007-lang/audits/audit-dependabot-automation-gap-2026-04-17.md.
27+
security-events: read
28+
# pull-requests: write lets the advisory "Comment on PR with findings"
29+
# step post its summary. Without it the built-in GITHUB_TOKEN gets
30+
# "Resource not accessible by integration" and (absent continue-on-error)
31+
# hard-fails the scan — exactly what the gate-decoupling design forbids.
32+
pull-requests: write
1533

1634
jobs:
1735
scan:
@@ -20,7 +38,7 @@ jobs:
2038

2139
steps:
2240
- name: Checkout repository
23-
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v4
41+
uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
2442
with:
2543
fetch-depth: 0 # Full history for better pattern analysis
2644

@@ -37,23 +55,27 @@ jobs:
3755
fi
3856
3957
- name: Build Hypatia scanner (if needed)
40-
working-directory: ${{ env.HOME }}/hypatia
4158
run: |
42-
if [ ! -f hypatia-v2 ]; then
43-
echo "Building hypatia-v2 scanner..."
44-
cd scanner
59+
cd "$HOME/hypatia"
60+
if [ ! -f hypatia ]; then
61+
echo "Building hypatia scanner..."
4562
mix deps.get
4663
mix escript.build
47-
mv hypatia ../hypatia-v2
4864
fi
4965
5066
- name: Run Hypatia scan
5167
id: scan
68+
env:
69+
# Pass the built-in Actions token through to Hypatia so the
70+
# DependabotAlerts rule can query this repo's own alerts.
71+
# For cross-repo scanning (fleet-coordinator scan-supervised),
72+
# a PAT with `security_events` scope is required instead.
73+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5274
run: |
5375
echo "Scanning repository: ${{ github.repository }}"
5476
55-
# Run scanner
56-
HYPATIA_FORMAT=json "$HOME/hypatia/hypatia-cli.sh" scan . > hypatia-findings.json
77+
# Run scanner (exits non-zero when findings exist — suppress to continue)
78+
HYPATIA_FORMAT=json "$HOME/hypatia/hypatia-cli.sh" scan . --exit-zero > hypatia-findings.json || true
5779
5880
# Count findings
5981
FINDING_COUNT=$(jq '. | length' hypatia-findings.json 2>/dev/null || echo 0)
@@ -75,33 +97,81 @@ jobs:
7597
echo "- Medium: $MEDIUM" >> $GITHUB_STEP_SUMMARY
7698
7799
- name: Upload findings artifact
78-
uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
100+
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
79101
with:
80102
name: hypatia-findings
81103
path: hypatia-findings.json
82104
retention-days: 90
83105

84106
- name: Submit findings to gitbot-fleet (Phase 2)
85107
if: steps.scan.outputs.findings_count > 0
108+
# Phase 2 is the collaborative LEARNING side-channel ("bots share
109+
# findings via gitbot-fleet"), not the security gate. The gate is
110+
# the baseline-aware "Check for critical or high-severity issues"
111+
# step below. A fleet-side regression (e.g. the submit script being
112+
# moved/removed) must NEVER hard-fail every consuming repo's scan.
113+
# Same reasoning as the "Comment on PR with findings" step.
114+
# See hyperpolymath/hypatia#213 (gate decoupling) and the exit-127
115+
# estate-wide breakage when gitbot-fleet/scripts/submit-finding.sh
116+
# no longer existed on the default branch.
117+
continue-on-error: true
86118
env:
119+
# All GitHub context values surface as env vars so the run
120+
# block never interpolates `${{ … }}` inline (closes the
121+
# workflow_audit/unsafe_curl_payload + actions_expression_injection
122+
# findings).
87123
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
124+
FLEET_PUSH_TOKEN: ${{ secrets.HYPATIA_DISPATCH_PAT }}
125+
FLEET_DISPATCH_TOKEN: ${{ secrets.HYPATIA_DISPATCH_PAT }}
88126
GITHUB_REPOSITORY: ${{ github.repository }}
89127
GITHUB_SHA: ${{ github.sha }}
128+
FINDINGS_COUNT: ${{ steps.scan.outputs.findings_count }}
90129
run: |
91-
echo "📤 Submitting ${{ steps.scan.outputs.findings_count }} findings to gitbot-fleet..."
130+
echo "📤 Submitting $FINDINGS_COUNT findings to gitbot-fleet..."
92131
93-
# Clone gitbot-fleet to temp directory
132+
# Clone gitbot-fleet to temp directory. A clone failure (network,
133+
# repo gone) is non-fatal: learning submission is best-effort.
94134
FLEET_DIR="/tmp/gitbot-fleet-$$"
95-
git clone https://github.com/hyperpolymath/gitbot-fleet.git "$FLEET_DIR"
135+
if ! git clone --depth 1 https://github.com/hyperpolymath/gitbot-fleet.git "$FLEET_DIR"; then
136+
echo "::warning::Could not clone gitbot-fleet — skipping Phase 2 learning submission (non-fatal)."
137+
exit 0
138+
fi
96139
97-
# Run submission script
98-
bash "$FLEET_DIR/scripts/submit-finding.sh" hypatia-findings.json
140+
# The submission script's location in gitbot-fleet has drifted
141+
# before (it was absent from the default branch, which exit-127'd
142+
# every consuming repo's scan). Probe known locations rather than
143+
# hard-coding one path, and skip gracefully if none is present.
144+
SUBMIT_SCRIPT=""
145+
for cand in \
146+
"$FLEET_DIR/scripts/submit-finding.sh" \
147+
"$FLEET_DIR/scripts/submit_finding.sh" \
148+
"$FLEET_DIR/bin/submit-finding.sh" \
149+
"$FLEET_DIR/submit-finding.sh"; do
150+
if [ -f "$cand" ]; then
151+
SUBMIT_SCRIPT="$cand"
152+
break
153+
fi
154+
done
155+
156+
if [ -z "$SUBMIT_SCRIPT" ]; then
157+
echo "::warning::gitbot-fleet submit-finding script not found at any known path — skipping Phase 2 learning submission (non-fatal). Findings are still uploaded as an artifact and gated below."
158+
rm -rf "$FLEET_DIR"
159+
exit 0
160+
fi
161+
162+
# Run submission script. Pass the findings path as ABSOLUTE —
163+
# the script cd's into its own working dir before reading the
164+
# file, so a relative path would resolve to the wrong place.
165+
# A submission-script failure is logged but non-fatal.
166+
if bash "$SUBMIT_SCRIPT" "$GITHUB_WORKSPACE/hypatia-findings.json"; then
167+
echo "✅ Finding submission complete"
168+
else
169+
echo "::warning::gitbot-fleet submission script exited non-zero — Phase 2 learning submission skipped (non-fatal)."
170+
fi
99171
100172
# Cleanup
101173
rm -rf "$FLEET_DIR"
102174
103-
echo "✅ Finding submission complete"
104-
105175
- name: Check for critical issues
106176
if: steps.scan.outputs.critical > 0
107177
run: |
@@ -146,7 +216,12 @@ jobs:
146216
147217
- name: Comment on PR with findings
148218
if: github.event_name == 'pull_request' && steps.scan.outputs.findings_count > 0
149-
uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v7
219+
# Advisory only — posting findings as a PR comment must never gate
220+
# the scan (hypatia#213 gate decoupling). Belt-and-braces alongside
221+
# the pull-requests: write permission above: a token/API hiccup or
222+
# a fork PR (read-only token) skips the comment, not the check.
223+
continue-on-error: true
224+
uses: actions/github-script@ed597411d8f924073f98dfc5c65a23a2325f34cd # v7
150225
with:
151226
script: |
152227
const fs = require('fs');

0 commit comments

Comments
 (0)