Skip to content

Commit d6e66cc

Browse files
committed
release: v1.2.3 - 引导强制化 + 项目追踪 + 操作反馈规范 + 开发流程文档化
v1.2.0: 引导流程硬约束(5步不可跳过)+ 4个README模板 + 职责边界 v1.2.1: 项目追踪(projects.yaml)+ global子目录化 + 新对话自动恢复 v1.2.2: Lint全通过 + Hook版本号同步 + 开发流程文档化 v1.2.3: 操作反馈规范(8种操作统一模板 + 会话记录追加后告知)
1 parent b0b03f4 commit d6e66cc

23 files changed

Lines changed: 617 additions & 66 deletions

.clawhubignore

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# ClawHub 发布时排除的文件
2+
# .git、LICENSE、.DS_Store、二进制文件 已被 ClawHub 自动排除,无需再写
3+
4+
# 开发者文档(普通用户不需要)
5+
DEVELOPMENT.md
6+
TEST-PLAN.md
7+
8+
# 测试目录
9+
test/
10+
11+
# 发布历史 zip 包(体积大,用户不需要)
12+
releases/
13+
14+
# 开发脚本
15+
scripts/
16+
17+
# 运行时状态文件
18+
skill-state.yaml
19+
20+
# IDE 配置
21+
.vscode/
22+
.idea/

CHANGELOG.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,101 @@
66

77
---
88

9+
## [1.2.3] - 2026-06-11
10+
11+
### 💬 操作反馈规范(用户反馈:每次记录/更新后明确告知)
12+
13+
- `core/main.md` 新增「操作反馈规范」段,统一所有操作的反馈模板
14+
- 覆盖 8 种操作:创建知识库、创建需求、更新状态、更新内容、归档、删除、自动会话记录、静默创建
15+
- 反馈原则:一句话确认 + 关键信息,不冗长
16+
- 自动会话记录从完全静默改为追加后告知(`📋 已记录本次会话到 {id}`
17+
- 明确不需要反馈的后台操作(PROJECT-STATUS 例行更新、projects.yaml last_access、自检通过)
18+
19+
## [1.2.2] - 2026-06-11
20+
21+
### 🔧 Lint 修复 + 开发流程文档化
22+
23+
#### Lint 全通过
24+
- Hook 文件版本号同步(4 个文件)
25+
- README.md badge + 性能对比表版本号同步
26+
- lint 脚本修复:`KNOWN_USER_FILES` 新增用户 KB 路径 + 目录引用 `rstrip` bug 修复
27+
- manifest.json 新增路径豁免规则
28+
29+
#### 开发流程文档化
30+
- `DEVELOPMENT.md` 新增「开发前必读」:Skill 内部规范 + 外部参考链接
31+
- 新增「版本号同步清单」:10 个文件的完整表格
32+
- 新增「经验教训」:记录 6 条历史踩坑记录
33+
- 发布检查清单更新:增加 `clawhub publish` 步骤
34+
35+
## [1.2.1] - 2026-06-11
36+
37+
### 🗂️ 项目追踪 + 新对话自动恢复
38+
39+
#### 全局知识库子目录化
40+
- `~/.myknowledge/global/` 从扁平结构改为 `global/{project-name}/` 子目录
41+
- 纯对话用户创建知识库时按项目名分子目录,不再全部混在一起
42+
- `settings.yaml` 存储路径同步更新
43+
44+
#### 项目目录管理(projects.yaml)
45+
- 新增 `~/.myknowledge/config/projects.yaml`,记录所有知识库位置
46+
- 创建知识库时自动追加条目(path、name、last_access、type)
47+
- 按需读取,不占常驻上下文
48+
- `core/templates/projects-yaml-spec.md` 定义格式规范
49+
50+
#### 新对话项目恢复
51+
- `core/main.md` 使用前检查新增"项目恢复"逻辑:
52+
- 当前目录有 `.myknowledge/` → 直接恢复(最快路径)
53+
- 无工作空间 → 读 `projects.yaml` 列出所有项目供选择
54+
- 选择了项目 → 更新 `last_access`
55+
- `onboarding/main.md` 步骤 4 初始化空的 `projects.yaml`
56+
57+
#### 错误处理增强
58+
- `modules/error/main.md` 新增"项目目录不存在"错误类型
59+
- 检测到项目文件夹被手动删除 → 自动从 `projects.yaml` 清理 → 提示用户
60+
61+
#### 版本号全量同步
62+
- `SKILL.md``settings.yaml``_meta.json``manifest.json``onboarding/main.md` 统一为 1.2.1
63+
64+
## [1.2.0] - 2026-06-11
65+
66+
### 🚀 引导流程强制化 + 模板体系完善
67+
68+
#### 引导流程修复(来自用户反馈)
69+
- **onboarding/main.md**:新增硬性规则——必须按序完成全部 5 步,每步骤需用户确认才能进入下一步
70+
- 步骤标注 `@阻塞性`/`@自动`/`@auto-detect`,AI 不可跳过或合并
71+
- 步骤 2 支持自动检测平台(`CODEBUDDY_*`/`WORKBUDDY_*` 等环境变量)
72+
- 步骤 5 增加前置校验:确认 `skill-state.yaml` 已写入才展示结束语
73+
- 新增"引导完成后硬性禁止"规则,防止正常使用时重新加载引导
74+
- **core/main.md 检查段**:从"加载 onboarding"改为"强制按序完成 onboarding 全部 5 步骤"
75+
- 明确 `⚠️ "加载 onboarding 文件" ≠ "完成引导"`
76+
77+
#### 新增 4 个 README 模板
78+
- `core/templates/kb-readme-template.md` — 知识库入口(项目简介+快速导航)
79+
- `core/templates/requirements-index-template.md` — 需求索引页(ID+标题+状态+时间)
80+
- `core/templates/public-readme-template.md` — 公开文件清单
81+
- `core/templates/archive-readme-template.md` — 归档索引(原因+日期+原链接)
82+
83+
#### 职责边界澄清
84+
-`core/main.md` 输出规范中新增"各 README 职责边界"表格
85+
- 明确区分 `requirements/README.md`(需求索引)与 `PROJECT-STATUS.md`(项目快照)
86+
- 创建知识库时自动使用对应模板,创建后告知用户各文件用途
87+
88+
#### 模板文件清单(共 6 个)
89+
| 模板 | 用途 |
90+
|------|------|
91+
| `kb-readme-template.md` | 知识库入口 |
92+
| `requirements-index-template.md` | 需求目录索引 |
93+
| `requirement-readme-template.md` | 单个需求详情 |
94+
| `public-readme-template.md` | 公开文件清单 |
95+
| `archive-readme-template.md` | 归档索引 |
96+
| `project-status-template.md` | 项目状态快照 |
97+
98+
## [1.1.18] - 2026-06-11
99+
100+
### 📝 description 精简 + 排除规则
101+
- `SKILL.md` description 从中英混杂改为简洁中英双语摘要
102+
- 新增 `.clawhubignore`,排除开发者文件(test/、releases/、DEVELOPMENT.md 等)
103+
9104
## [1.1.17] - 2026-06-11
10105

11106
### 🔧 配置一致性修复 + 自动化防护

DEVELOPMENT.md

Lines changed: 92 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -284,6 +284,55 @@ version: "1.0.0"
284284

285285
## 发布流程
286286

287+
### 开发前必读
288+
289+
修改 Skill 内容前,确保了解以下规范:
290+
291+
**Skill 内部规范(必读):**
292+
1. [ClawHub SKILL.md 格式规范](https://docs.openclaw.ai/clawhub/skill-format) — frontmatter 字段定义
293+
2. 本项目 `scripts/lint-paths.sh` — 了解 8 项检查的规则和逻辑
294+
3. 本文件「开发规范」章节 — Prompt 编写、配置变更、新增功能流程
295+
4. 本文件「文档措辞规范」章节 — 避免负面标签被平台误判
296+
297+
**外部参考(按需):**
298+
- [SKILL.md 开放标准](https://www.agensi.io/learn/skill-md-specification-open-standard) — 跨平台 SKILL.md 规范
299+
- [ClawHub 发布指南](https://clawhub.ai/luduoxin/skill-publish-guide) — 发布流程和常见错误
300+
- [OpenClaw 中文文档](https://docs.openclaw.ac.cn/tools/clawhub) — ClawHub 中文说明
301+
302+
---
303+
304+
### 版本号同步清单(共 10 个文件)
305+
306+
> ⚠️ 改版本号时必须全部同步,lint 第 5 项会自动检查。
307+
308+
| # | 文件 | 位置 |
309+
|---|------|------|
310+
| 1 | `SKILL.md` | frontmatter `version` |
311+
| 2 | `settings.yaml` | `skill.version` + `version_compatibility.current` |
312+
| 3 | `_meta.json` | `version` |
313+
| 4 | `manifest.json` | `version` |
314+
| 5 | `one-time/onboarding/main.md` | 步骤 4 的 skill-state.yaml 模板 |
315+
| 6 | `hooks/claude/hooks.json` | `version` |
316+
| 7 | `hooks/claude/README.md` | 示例中的 `version` |
317+
| 8 | `hooks/openclaw/HOOK.md` | frontmatter `version` |
318+
| 9 | `hooks/openclaw/hook-guide.md` | 示例中的 `version` |
319+
| 10 | `README.md` | badge + 性能对比表 |
320+
321+
### 经验教训
322+
323+
> 记录每次发布踩过的坑,避免重复犯错。
324+
325+
| 日期 | 版本 | 问题 | 教训 |
326+
|------|------|------|------|
327+
| 2026-06-11 | 1.2.1→1.2.2 | ClawHub 不允许覆盖同版本 | 发布前先跑 lint,发布后发现 lint 不通过需升版本号 |
328+
| 2026-06-11 | 1.2.1 | 改了 5 个文件的版本号,忘了 Hook 4 个 + README 2 处 | 版本号用 lint 第 5 项自动检查,不要人工记 |
329+
| 2026-06-11 | 1.2.1 | lint 误报用户 KB 路径(`requirements/README.md` 等) | 新增用户侧路径时加入 `KNOWN_USER_FILES``manifest.json` 豁免 |
330+
| 2026-06-11 | 1.2.3 | 只做了 lint + clawhub publish,忘了 build-skillhub.sh 生成 SkillHub zip | ClawHub 和 SkillHub 是两个独立渠道,发布步骤:lint → build → clawhub publish,缺一不可 |
331+
| 2026-06-11 | 1.1.12 | FAQ + PITFALLS 没进 zip | 新增文件需确认进 `manifest.json``skillhub_includes` |
332+
| 2026-06-11 | 1.1.11 | 负面标签("误触发""漏检")被平台误判为缺陷 | 遵循文档措辞规范,用中性表述 |
333+
334+
---
335+
287336
### 版本号规范(SemVer)
288337

289338
```
@@ -295,15 +344,47 @@ version: "1.0.0"
295344
- 修订号:向下兼容的问题修复
296345
```
297346

347+
## 发布工作流
348+
349+
> MyKnowledge 通过 3 个渠道分发,各有不同用途:
350+
351+
| 渠道 | 命令/方式 | 产出 | 用途 |
352+
|------|----------|------|------|
353+
| ClawHub 注册表 | `clawhub publish` | 在线注册 | OpenClaw/WorkBuddy 用户一键安装 |
354+
| SkillHub(腾讯镜像) | `bash scripts/build-skillhub.sh` | `releases/MyKnowledge-x.x.x-skillhub.zip` | 提交到 SkillHub 国内镜像 |
355+
| GitHub Release | `git tag + push` | GitHub Release 页面 | 开源仓库版本管理 |
356+
357+
### 发布步骤(严格按序执行)
358+
359+
```
360+
1. 修改代码,版本号同步 10 个文件
361+
2. bash scripts/lint-paths.sh ← 必须全绿,否则阻止后续
362+
3. bash scripts/build-skillhub.sh ← 生成 releases/ zip(给 SkillHub)
363+
4. clawhub publish ... ← 推送到 ClawHub 注册表
364+
5. git 提交流程:
365+
git add -A
366+
git commit -m "release: vX.Y.Z - {简要说明}"
367+
git push origin main ← 先推代码
368+
git tag vX.Y.Z
369+
git push origin vX.Y.Z ← 再推 tag(触发 GitHub Actions)
370+
```
371+
372+
> ⚠️ Git 提交流程不能只打 tag,必须先 `commit + push` 代码,再 `tag + push tag`
373+
> GitHub Actions 在收到 tag push 后自动执行:lint → build → 创建 GitHub Release(上传 skillhub.zip + github.zip)。
374+
375+
> ⚠️ 第 3 步生成的 zip 用于提交到 SkillHub(腾讯国内镜像),第 4 步 `clawhub publish` 推的是文件夹内容到 ClawHub 官方注册表。两个是不同的分发渠道,**都要做**
376+
298377
### 发布检查清单
299378

300-
- [ ] 版本号更新(`settings.yaml`, `_meta.json`, `SKILL.md`10 个文件)
379+
- [ ] 版本号更新(见上方「版本号同步清单」10 个文件)
301380
- [ ] CHANGELOG.md 更新
302-
- [ ] `bash scripts/lint-paths.sh` 通过
381+
- [ ] `bash scripts/lint-paths.sh` 通过(8 项全绿)
303382
- [ ] `bash scripts/build-skillhub.sh` 生成 zip 到 `releases/`
304-
- [ ] `git tag vX.Y.Z && git push --tags`(触发 GitHub Actions)
305-
- [ ] 确认 GitHub Release 创建成功
306-
- [ ] Skill Hub 提交(如适用)
383+
- [ ] `clawhub publish` 发布到 ClawHub
384+
- [ ] `git add -A && git commit -m "release: vX.Y.Z"`
385+
- [ ] `git push origin main`
386+
- [ ] `git tag vX.Y.Z && git push origin vX.Y.Z`
387+
- [ ] 确认 GitHub Actions 执行成功(Release 创建)
307388

308389
---
309390

@@ -344,14 +425,19 @@ version: "1.0.0"
344425
- [x] v1.1.12:用户文档随 Skill 分发(FAQ + PITFALLS 进 zip + SKILL.md 用户支持章节)
345426
- [x] v1.1.13:安全设计文档化("不自动重试"原因说明)
346427

347-
### v1.2.0(未来)
428+
### v1.2.x(已发布/进行中)
429+
- [x] v1.2.0:引导流程强制化 + 模板体系完善 + 职责边界澄清
430+
- [x] v1.2.1:项目追踪(projects.yaml)+ 全局知识库子目录化 + 新对话自动恢复
431+
432+
### v1.3.0(未来)
348433
- [ ] 关键词搜索
349434
- [ ] 一键导出/分享:打包项目知识库为可分享文件
350435
- 导出包含 PROJECT-STATUS.md + 需求摘要 + 安装引导
351436
- 对方有 MyKnowledge → 说"导入知识库"一键录入
352437
- 对方无 MyKnowledge → 分享包内 INSTALL-GUIDE.md 引导安装
353438
- [ ] 与 Agent Team Skill 集成
354439
- [ ] 需求优先级/标签/依赖
440+
- [ ] 嵌套/子需求支持
355441

356442
### 未来考虑
357443
- [ ] ClawHub 官方支持

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<p align="center">
2-
<img src="https://img.shields.io/badge/version-1.1.17-blue" alt="Version" />
2+
<img src="https://img.shields.io/badge/version-1.2.3-blue" alt="Version" />
33
<img src="https://img.shields.io/badge/license-Apache%202.0-green" alt="License" />
44
<a href="https://github.com/CoderMoray/MyKnowledge"><img src="https://img.shields.io/badge/GitHub-CoderMoray-black?logo=github" alt="GitHub" /></a>
55
</p>
@@ -54,7 +54,7 @@
5454

5555
## 📊 性能对比
5656

57-
| 指标 | v1.0.0 | v1.1.17 | 变化 |
57+
| 指标 | v1.0.0 | v1.2.3 | 变化 |
5858
|------|--------|--------|------|
5959
| 主模块代码量 | 387 行 | **~250 行** | 🔻 -35% |
6060
| 日常上下文占用 | ~9K tokens | **~5K tokens** | 🔻 -44% |

SKILL.md

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,7 @@
11
---
22
name: myknowledge
3-
description: |
4-
当用户需要创建知识库、管理项目文档、记录需求、整理个人知识时使用。
5-
6-
⚠️ 首次安装后:安装完成时主动提示用户"已安装 MyKnowledge!是否现在进行首次设置?(约 1 分钟)"
7-
如果用户同意,立即检查 ~/.myknowledge/config/skill-state.yaml 并执行首次引导。
8-
9-
⚠️ 每次使用前检查初始化状态:
10-
1. 检查 skill-state.yaml 是否存在
11-
2. 如果不存在 → 执行首次引导(one-time/onboarding/main.md)
12-
3. 如果存在 → 直接执行用户请求(core/main.md)
13-
14-
首次引导只执行一次,之后不再显示。
15-
version: "1.1.17"
3+
description: 创建知识库、管理项目文档、记录需求、整理个人知识。Create knowledge bases, manage project docs, track requirements, and organize personal knowledge.
4+
version: "1.2.3"
165
author: CoderMoray
176
tags:
187
- "knowledge-base"

_meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
"name": "myknowledge",
33
"displayName": "MyKnowledge",
44
"displayName_zh": "我的知识库",
5-
"version": "1.1.17",
5+
"version": "1.2.3",
66
"description": "通用知识库管理 Skill,支持需求管理、项目文档、自动记录复杂任务",
77
"description_zh": "通用知识库管理 Skill,支持需求管理、项目文档、自动记录复杂任务",
88
"author": "CoderMoray",

0 commit comments

Comments
 (0)