shumengya
6c2db2dfa3
- 每任务一目录结构，统一开关与日志 - cronctl CLI：enable/disable/toggle/status/run/sync-cron - 公共库 lib/shumengya_cron：runner/manager/notify/ssh - _template 示例任务（hello world + 复制模板） - webui 管理面板：FastAPI 后端 + 文档式响应式前端
定时任务模板 / 示例任务
_template 本身是可管理的真实任务：每天 08:00 输出 hello world。
新建任务时复制本目录，改任务名与业务逻辑即可。
新建步骤
TASK_ID="smallmengya-my-new-task"
CRON_ROOT="/shumengya/project/agent/sproutclaw-cron"
cp -a "$CRON_ROOT/_template" "$CRON_ROOT/$TASK_ID"
sed -i "s/_template/$TASK_ID/g" "$CRON_ROOT/$TASK_ID/schedule.cron"
chmod +x "$CRON_ROOT/$TASK_ID/switch.sh"
# 编辑 run.py，替换 hello world 为实际业务逻辑
# 编辑 schedule.cron，调整 cron 表达式与注释
python3 "$CRON_ROOT/cronctl.py" status "$TASK_ID"
python3 "$CRON_ROOT/cronctl.py" run "$TASK_ID" # 手动试跑
python3 "$CRON_ROOT/cronctl.py" enable "$TASK_ID" # 开启并同步 /etc/cron.d/
必须文件
| 文件 | 说明 |
|---|---|
run.py |
任务入口，导出 run(ctx) -> int |
schedule.cron |
系统 cron 配置，cron 行须调用 cronctl.py run <task-id> |
switch.sh |
可选，代理 cronctl 开关 |
run.py 约定
- 入口第一行检查
task_is_disabled(ctx)，关闭时直接return 0 - 使用
task_logging(ctx)写日志到logs/<task-id>.log - 使用
acquire_cron_lock(ctx.lock_file, log=log)防止并发重入 - 业务逻辑写在
log("start")与log("end")之间 - 需要汇总通知时使用
shumengya_cron.notify.send_task_summary
schedule.cron 约定
- 保留
SHELL/PATH/HOME/CRON_MAIL_ENABLED头部 - 用
#注释写一句任务说明（WebUI 会读取展示） - cron 行格式：
分 时 日 月 周 root python3 .../cronctl.py run <task-id> >/dev/null 2>&1 - 本模板默认 每天 08:00（
0 8 * * *）
任务 ID 命名
<主机名>-<功能描述>，例如 smallmengya-gitea-repo-sync。