feat(miner): audit DEPLOYMENT.md env vars, paths, and CLI subcommands against source - #5414
Conversation
… against source Mirror the self-host docs-accuracy audit (apps/gittensory-ui/src/lib/selfhost-docs-audit.ts) for packages/gittensory-miner/DEPLOYMENT.md. A new lib/deployment-docs-audit.js module parses the deployment doc and cross-checks every GITTENSORY_MINER_*/MINER_* env var, repo-relative file path, and gittensory-miner <subcommand> it documents against the live source tree, so a rename or move that leaves the doc stale fails CI with a message naming the exact stale claim instead of silently misleading operators. The check runs as a vitest drift guard (test/unit/miner-deployment-docs-audit.test.ts) wired into npm run test:ci, with success and failure fixtures for each claim type, a renamed-var regression, and an invariant that the audit never silently passes on drift. Closes JSONbored#5180
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5414 +/- ##
=======================================
Coverage 94.45% 94.45%
=======================================
Files 552 553 +1
Lines 44310 44350 +40
Branches 14659 14659
=======================================
+ Hits 41851 41891 +40
Misses 1784 1784
Partials 675 675
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
|
Tip 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩 ✅ Gittensory review result - approve/merge recommendedReview updated: 2026-07-12 17:33:30 UTC
✅ Suggested Action - Approve/Merge
Review summary Nits — 5 non-blocking
Linked issue satisfactionAddressed Review context
Contributor next steps
Signal definitions
[BETA] Chat with GittensoryAsk Gittensory a question about this PR directly in a comment — grounded only in the same cached, public-safe facts shown above, never a new claim.
Full command reference: https://gittensory.aethereal.dev/docs/gittensory-commands 🟩 Safe / merged · 🟦 Advisory · 🟨 Held for review · 🟥 Blocked / closed 💰 Earn for open-source contributions like this. Gittensor lets GitHub contributors earn for the work they already do — register to start earning →. Checked by Gittensory, a quiet PR intelligence layer for OSS maintainers.
|
What
Mirrors the self-host docs-accuracy audit (
apps/gittensory-ui/src/lib/selfhost-docs-audit.ts) for the miner package. A newpackages/gittensory-miner/lib/deployment-docs-audit.jsmodule parsespackages/gittensory-miner/DEPLOYMENT.mdand cross-checks every claim it makes against the live source tree:GITTENSORY_MINER_*/MINER_*name the doc references must still be read somewhere underpackages/gittensory-miner/**.k8s/,systemd/…, docs) must still resolve on disk; external issue links are ignored.gittensory-miner <subcommand>must still be registered in the CLI dispatch table (parsed from the bin entry), and the@jsonbored/gittensory-minerpackage spelling is not mistaken for a subcommand.On any drift the audit fails with a message naming the exact stale claim (var / path / subcommand) rather than a generic failure.
Wiring
Runs as a vitest drift guard,
test/unit/miner-deployment-docs-audit.test.ts, which is part ofnpm run test:ci(viatest:coverage) — the same pattern as the existing self-host audit checklist test.Tests
Full branch coverage on the new module: success and failure fixtures for each claim type, a renamed-env-var regression, an invariant that the audit never silently passes on drift, and a green pass against
DEPLOYMENT.md's current, accurate state.Closes #5180