Skip to content

auto-report

用于 NPC 在“干完活”后,稳定输出一份可读、可追踪、可复盘的任务汇报,并主动回传给 OpenClaw

何时触发

当用户指令含有以下意图时触发:

  • 完成后汇报
  • 做完给我同步
  • 输出结果总结
  • 提交后发执行报告
  • 请给详细复盘

输入约定

  • TASK_TITLE:任务名称
  • DETAIL_LEVELminimal | normal | detailed
  • CHANGED_FILES:逗号分隔文件列表(可选)
  • DECISIONS:逗号分隔关键决策(可选)
  • RISKS:逗号分隔风险点(可选)
  • NEXT_STEPS:逗号分隔后续动作(可选)
  • OUTPUT_PATH:报告输出路径(默认 ./auto-report-report.md
  • RELATED_LINKS:逗号分隔链接(可选,如 PR#12,Issue#8
  • REPORT_TO_OPENCLAW:是否主动上报(true|false
  • REPORT_PUSH_MODEcnb_issue_comment | cnb_pull_comment | webhook | none
  • OPENCLAW_MENTION:回报时 @ 的目标(默认 @openclaw
  • TASK_ID:任务 ID(可选,方便 OpenClaw 关联)
  • REPORTER_NAME:执行体名称(如某 NPC)
  • OPENCLAW_WEBHOOK_URLwebhook 模式目标地址
  • REPORT_FAIL_ON_PUSH_ERROR:上报失败是否中断(true|false

输出

生成 Markdown 报告,默认结构:

  1. 任务与时间
  2. 完成内容
  3. 变更文件
  4. 关键决策(normal/detailed)
  5. 风险与建议(detailed)
  6. 后续动作
  7. 相关链接

与 NPC 工作流集成(无轮询)

推荐在“任务结束钩子”调用:

bash
bash scripts/report.sh

推荐默认开启主动上报,让 OpenClaw 不再轮询:

bash
export REPORT_TO_OPENCLAW=true
export REPORT_PUSH_MODE=cnb_issue_comment
export OPENCLAW_MENTION="@openclaw"
bash scripts/report.sh

设计原则

  • 结果优先:先给完成状态和改动,再给解释
  • 结构统一:不同任务保持一致输出模板
  • 可配置:通过环境变量切换详细程度与字段
  • 主动回传:任务结束即 push 给 OpenClaw,避免轮询
  • 低耦合:作为独立脚本,可被其它 skill 复用

由云锦鸿维护