chore: auto release commit (2026-06-14 11:12:03)
All checks were successful
技能自动化发布 / release (push) Successful in 8s
All checks were successful
技能自动化发布 / release (push) Successful in 8s
This commit is contained in:
119
README.md
119
README.md
@@ -1,80 +1,77 @@
|
||||
# 匠厂 技能开发模板(通用业务)
|
||||
---
|
||||
description: "用用户能理解的方式说明这个技能能做什么、适合什么场景,以及如何开始使用。"
|
||||
---
|
||||
|
||||
这是一个**规范化的新技能模板仓库**,用于复制出新的 skill 项目;它本身**不是业务 skill**。
|
||||
# 【技能名称】
|
||||
|
||||
## 模板目标
|
||||
用一两句话说明这个技能帮助用户完成什么工作。
|
||||
这里不要解释技术实现,要从用户的业务目标出发描述价值。
|
||||
|
||||
- 对齐当前规范 skill 的目录结构:`assets/`、`references/`、`scripts/`、`tests/`、`evals/`
|
||||
- 对齐当前规范脚手架分层:`scripts/cli`、`scripts/db`、`scripts/service`、`scripts/util`;公共能力从共享 runtime 的 `jiangchang-platform-kit` 引用
|
||||
- 提供最小可运行入口:`python scripts/main.py health` / `config-path` / `version`,以及通用任务命令骨架 `run` / `logs` / `log-get`
|
||||
- 内置 **配置 bootstrap**:`.env.example` 首次落盘到 `{DATA_ROOT}/{USER_ID}/{slug}/.env`,升级后合并缺失 key(见 `scripts/util/config_bootstrap.py`)
|
||||
- 内置 **隔离测试体系**:`IsolatedDataRoot`、双键环境、`OPENCLAW_TEST_TARGET` 档位与 adapter profile 策略(详见 [`references/TESTING.md`](references/TESTING.md))
|
||||
- 让新技能从一开始就按规范落地,不再沿用旧模板的 `docs/`、`optional/`、`skill_main.py` 结构
|
||||
## 这个技能能帮你做什么
|
||||
|
||||
## 新技能使用步骤
|
||||
用 3 到 6 条业务能力说明技能价值,例如:
|
||||
|
||||
1. 复制本目录为新的 skill 仓库。
|
||||
2. 全局替换 `your-skill-slug`、`your-platform-key`、`您的技能显示名称` 等占位内容。
|
||||
3. 修改 `SKILL.md`、`references/` 和 `scripts/util/constants.py`。
|
||||
4. 在 `scripts/service/task_service.py` 中实现真实业务编排与外部系统对接。
|
||||
5. 运行 `python tests/run_tests.py -v`,再执行 `python scripts/main.py health`、`version` 做最小验证。
|
||||
- 【自动整理/查询/生成/同步/核对/提交】某类业务数据
|
||||
- 帮你减少重复操作,降低人工录入或核对成本
|
||||
- 在任务完成后给出清晰的处理结果、失败原因或后续建议
|
||||
|
||||
如果你的技能在平台里默认是非公开的(`access_scope = 0`),建议在 `SKILL.md` 的 `metadata.openclaw.developer_ids` 中填写开发者用户 ID 列表。这样在正式发布后,平台会为这些开发者补可见权限,避免「技能已上架但开发者自己在市场中看不到」。
|
||||
## 适合什么场景
|
||||
|
||||
开发教程入口:
|
||||
列出典型使用场景。请使用用户熟悉的业务语言,例如:
|
||||
|
||||
- <a href="references/REQUIREMENTS.md" target="_blank" rel="noopener noreferrer">需求文档模板</a>:给技术人员编写和查看研发需求的标准模板
|
||||
- <a href="references/DEVELOPMENT.md" target="_blank" rel="noopener noreferrer">开发教程</a>:给技术人员的完整开发步骤说明
|
||||
- <a href="references/TESTING.md" target="_blank" rel="noopener noreferrer">测试开发指南</a>:默认套件、隔离数据根、档位开关与 FakeAdapter 怎么用
|
||||
- 每天需要重复处理同一类订单、单据、报表或客户资料
|
||||
- 需要从多个系统中查询信息并汇总结果
|
||||
- 需要按固定规则检查数据是否完整、是否异常
|
||||
- 需要把处理结果保存为文件、记录或任务报告
|
||||
|
||||
## 目录说明
|
||||
## 使用前需要准备什么
|
||||
|
||||
| 路径 | 用途 |
|
||||
|------|------|
|
||||
| `SKILL.md` | 技能清单与触发说明模板 |
|
||||
| `assets/` | 示例输出与轻量 schema |
|
||||
| `references/` | 面向用户与编排的文档模板 |
|
||||
| `scripts/` | 规范分层后的代码骨架 |
|
||||
| `tests/` | 单元测试与分层测试范式(默认根目录 unittest) |
|
||||
| `evals/` | 人工/半自动评估材料 |
|
||||
| `requirements.txt` | 本技能 Python 三方依赖声明(由匠厂宿主安装到共享 runtime) |
|
||||
| `.github/workflows/release_skill.yaml` | 标准发布工作流 |
|
||||
| `release.ps1` | 对齐现有 skill 的发布脚本入口 |
|
||||
说明用户在使用前要准备的东西,例如:
|
||||
|
||||
## 最小命令
|
||||
- 相关账号已登录,且具备查询、导出或提交权限
|
||||
- 需要处理的文件、时间范围、订单号、客户名称、项目名称等信息
|
||||
- 如果涉及外部系统,请确认网络、账号、验证码或审批流程可正常使用
|
||||
|
||||
```bash
|
||||
python scripts/main.py health
|
||||
python scripts/main.py version
|
||||
```
|
||||
## 你可以这样告诉 Agent
|
||||
|
||||
## 注意
|
||||
用自然语言示例展示用户可以怎么发起任务,例如:
|
||||
|
||||
- 不要再往模板里引入旧式 `docs/` 或 `optional/` 目录。
|
||||
- 新技能若不需要某些目录,也建议先保留结构,再按实际业务填充内容。
|
||||
- `metadata.openclaw.developer_ids` 是发布元数据,不是用户展示文案;用于非公开技能的开发者默认可见授权。
|
||||
- **发起 `release.ps1` 之前**,务必确认 `python tests/run_tests.py -v` 已全部通过。
|
||||
- “帮我查询今天的【业务对象】,整理成表格。”
|
||||
- “帮我核对这些【数据/单据】是否有异常,并告诉我问题在哪里。”
|
||||
- “帮我把【时间范围】内的【业务数据】导出并生成处理报告。”
|
||||
- “帮我根据这个文件里的内容,逐条完成【业务动作】。”
|
||||
|
||||
## Python 依赖(requirements.txt)
|
||||
注意:示例应是自然语言,不要写命令行命令。
|
||||
|
||||
- `jiangchang-platform-kit`、`playwright`、config、runtime diagnostics、RPA 公共能力等由**宿主共享 runtime** 提供;`jiangchang_skill_core` **不在技能仓库内复制**。
|
||||
- 新技能**不得 vendored** `scripts/jiangchang_skill_core/`;复制模板后若发现该目录,应删除并改为依赖共享 venv。
|
||||
- 在技能**根目录**维护 `requirements.txt`,**只声明技能特有** Python 三方包;**不要**重复声明 `jiangchang-platform-kit` 或 `playwright`。
|
||||
- `SKILL.md` 的 `metadata.openclaw.platform_kit_min_version`(当前 `1.0.13`)是运行契约/兼容性声明,供宿主安装与启用时校验,**不是** pip 依赖声明。`jiangchang-platform-kit>=1.0.13` 是当前 RPA 视频/旁白/背景音乐/前后缓冲等标准能力的最低版本。
|
||||
- 匠厂宿主在**安装或更新**技能后,会将技能 `requirements.txt` 中的依赖安装到共享 Python runtime:
|
||||
`{JIANGCHANG_DATA_ROOT}/python-runtime/.venv`(Windows 示例:`D:\jiangchang-data\python-runtime\.venv`)。
|
||||
- **Skill 业务代码不得自动 `pip install`**;缺依赖时应在 `health` / preflight 中给出清晰错误。
|
||||
- **系统级组件**(如 Microsoft Visual C++ Redistributable)**不要**写进 `requirements.txt`;仅在 `health` / preflight 中提示用户自行安装。
|
||||
- 独立本地开发环境若缺少公共包,可手动安装;**生产/宿主运行**由共享 runtime 负责,无需在技能内 `pip install playwright`。
|
||||
## 执行后你会得到什么
|
||||
|
||||
## 公共能力边界
|
||||
说明用户会看到什么结果,例如:
|
||||
|
||||
以下能力均由 `jiangchang-platform-kit`(共享 runtime 的 `jiangchang_skill_core`)提供,技能只写业务逻辑与薄封装,**不要**在技能内复制实现:
|
||||
- 任务是否成功完成
|
||||
- 处理了多少条数据
|
||||
- 哪些内容成功、哪些失败
|
||||
- 失败原因和建议处理方式
|
||||
- 生成的文件、表格、报告或记录
|
||||
|
||||
- `config` — `.env` 三级优先级读取与首次落盘
|
||||
- `runtime_env` — 数据根、用户 ID、兄弟技能根解析
|
||||
- `unified_logging` — 统一日志与 trace
|
||||
- `rpa` — 浏览器/桌面/手机 RPA 共享库
|
||||
- `media_assets` — 共享媒体资源探测与路径解析
|
||||
- `video_session` — RPA 录屏成片(ffmpeg、字幕、背景音乐)
|
||||
- `runtime_diagnostics` — `health` 统一 runtime 诊断
|
||||
## 注意事项
|
||||
|
||||
用用户能理解的方式说明边界和风险,例如:
|
||||
|
||||
- 请确认输入范围准确,避免处理错数据
|
||||
- 涉及提交、付款、删除、审批等高风险动作时,技能应在执行前请求确认
|
||||
- 如果外部系统登录失效、权限不足或页面变化,任务可能需要用户介入
|
||||
- 不建议在未核对数据的情况下直接执行批量操作
|
||||
|
||||
## 常见问题
|
||||
|
||||
### 为什么任务没有查到数据?
|
||||
|
||||
可能是时间范围、关键词、账号权限或系统筛选条件不正确。请先确认输入信息是否准确。
|
||||
|
||||
### 为什么任务执行到一半需要我操作?
|
||||
|
||||
可能遇到了登录、验证码、权限确认、二次审批或系统异常。请根据 Agent 的提示完成必要操作。
|
||||
|
||||
### 结果文件在哪里查看?
|
||||
|
||||
请根据 Agent 返回的结果说明查看生成文件、任务记录或处理报告。
|
||||
|
||||
Reference in New Issue
Block a user