scienceisneato/Slop-Mop

Run Slop-Mop swab or scour in GitHub Actions with hull grade, SARIF, JSON, and job-summary output.

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Stale
License
None
namedescriptionrequireddefault
commandSlop-Mop validation command to run. Supported values: swab, scour.noscour
argsExtra arguments passed to sm before the action-managed output flags.no--no-auto-fix
python-versionPython version used to install and run Slop-Mop.no3.12
install-extraSlop-Mop PyPI extra to install alongside core. Empty by default in v2: gate tools are installed from the committed dependency manifest by exact pin, so the broad `all` extra is no longer needed. Set to e.g. `all` to restore the v1 install-everything behaviour.no""
slopmop-versionSlop-Mop version specifier, such as ==2.11.0 or >=2.11.0. Pinned by default so the install cache is deterministic; the Slop-Mop release workflow bumps this on each release. Must be a version that supports `sm doctor --required-deps`.no==2.12.0
manifest-filePath to the committed dependency manifest produced by `sm doctor --required-deps`. The action installs exactly the tools it lists, by exact pin. Generate/refresh it with: `sm doctor --required-deps > .slopmop/required-deps.json`.no.slopmop/required-deps.json
verify-manifestFail the run when the committed manifest has drifted from the repo's live gate config (a tool was added/removed/repinned but the manifest wasn't regenerated). Keeps the committed artifact honest.notrue
project-installOptional shell command that installs the TARGET PROJECT's own dependencies before scanning (e.g. `python -m venv venv && ./venv/bin/pip install -e ".[all]"`). The action installs slop-mop and its gate tools — not your project's deps — but type-aware gates (pyright/mypy) and dependency auditing resolve against the project environment (./venv, ./.venv, or $VIRTUAL_ENV). Without it those gates may report phantom unknown-type findings or audit the wrong dependency set. Leave empty if your workflow already provisions the environment.no""
results-filePath where Slop-Mop JSON results should be written.noslopmop-results.json
sarif-filePath where Slop-Mop SARIF should be written.noslopmop.sarif
upload-sarifUpload SARIF to GitHub Code Scanning.notrue
sarif-categoryCode Scanning category for uploaded SARIF.noslopmop
strict-sarif-uploadFail the action if SARIF upload fails.nofalse
fail-on-failureFail the action when sm exits non-zero.notrue
minimum-gradeFail the action when the hull grade is worse than this letter (A+, A, B, C, D, F). Empty disables grade enforcement. A non-empty value that isn't one of those letters fails the action as a misconfiguration. N/A (dry-dock, repo not initialized) never fails the threshold.no""
namedescription
resultpassed or failed, based on the sm exit code.
exit_codeRaw sm exit code.
results_fileJSON results file path.
sarif_fileSARIF file path.
gradeHull grade letter: A+, A, B, C, D, F, or N/A. Empty when slopmop did not emit a grade.
hullHull condition name: shipshape, seaworthy, serviceable, weathered, fouled, scuttled, or dry-dock.
failingNumber of failing gates counted toward the grade.
warnedNumber of warned gates.
provisionaltrue when operational skips (missing tool, fail-fast, time budget) may have hidden failing gates.
hull_grade_jsonCompact hull_grade JSON object, when emitted by Slop-Mop.
grade_mettrue/false when minimum-grade is set and the grade is comparable; empty otherwise.