docs(miner): add unattended scheduling & failure-alerting guidance - #5592
Conversation
Operational guidance (JSONbored#4840) for running the miner's two scheduled commands (`manage poll`, `discover`) unattended: the shared exit-code contract (0 success / 2 failure) that alerting keys on, the `--no-update-check` / `--json` flags for scheduled runs, worked cron and systemd service+timer examples, and three failure-alerting patterns (cron MAILTO/logger, systemd OnFailure=, and a wrapper script). Closes JSONbored#4840
|
Superagent didn't find any vulnerabilities or security issues in this PR. |
|
Tip 🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩🟩 ✅ Gittensory review result - approve/merge recommendedReview updated: 2026-07-13 07:45:10 UTC
✅ Suggested Action - Approve/Merge
Review summary Nits — 6 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.
|
Summary
(Resubmit of #5584, closed by the orb: the AI reviewer correctly caught that the cron guidance overstated
MAILTO(cron mails output, not exit status) and that a bare|| loggermasks the failure. Both are fixed here — the examples now capture and re-raise the exit code (status=$?; …; exit "$status"), and the text explains cron's actual output-vs-exit behavior.)Adds operational guidance (#4840) for running the miner's two scheduled commands —
manage pollanddiscover— unattended, and for alerting on failures.Doc:
packages/gittensory-miner/docs/unattended-scheduling.md. Covers:0success /2failure) that every scheduler keys on for alerting — verified againstmanage-poll.jsanddiscover-cli.js.--no-update-check/GITTENSORY_MINER_NO_UPDATE_CHECK=1(skip the npm nudge) and--json(machine-parseable output).MAILTO+ a|| loggerfallback that captures the failing exit code).oneshotservice + timer, usingOnFailure=as the alerting hook.MAILTO/logger, systemdOnFailure=templated unit, and a scheduler-agnostic wrapper script.Scope
type(scope): short summaryConventional Commit format.CONTRIBUTING.mdand does not reintroduce GitHub Pages, VitePress,site/, orCNAME.Closes #4840.Validation
git diff --checknpm run docs:drift-check(passes — no mechanically-checkable claim goes stale)manage-poll.js,discover-cli.jsexit0/2;update-check.js--no-update-check/GITTENSORY_MINER_NO_UPDATE_CHECK)If any required check was skipped, explain why:
.md, no code). Nosrc/**/apps/**/package changes, so Codecov and the backend/UI/MCP CI jobs are path-skipped; there is no code to test.Safety
Notes
operations-runbook.mdand../DEPLOYMENT.mdrather than duplicating their scope.Closes #4840