From bb555229d042b0852dd0fe21caf462349a44b222 Mon Sep 17 00:00:00 2001 From: ila <2+ila@noreply.git.ilapage.cn> Date: Tue, 18 Aug 2026 21:39:15 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E5=A1=AB=E5=86=99=20#23=20=E4=BB=BB?= =?UTF-8?q?=E5=8A=A1=E5=BD=92=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...E5%B9%B6dev_scripts%E5%85%A5%E5%8F%A3.-.md | 77 +++++++++++++++---- 1 file changed, 62 insertions(+), 15 deletions(-) diff --git a/Task-23-%E5%90%88%E5%B9%B6dev_scripts%E5%85%A5%E5%8F%A3.-.md b/Task-23-%E5%90%88%E5%B9%B6dev_scripts%E5%85%A5%E5%8F%A3.-.md index d9c9e26..5b5cf0a 100644 --- a/Task-23-%E5%90%88%E5%B9%B6dev_scripts%E5%85%A5%E5%8F%A3.-.md +++ b/Task-23-%E5%90%88%E5%B9%B6dev_scripts%E5%85%A5%E5%8F%A3.-.md @@ -1,42 +1,89 @@ -# 23 合并dev_scripts入口 +# 23 合并 dev_scripts 入口 -- 类型:需求 / 缺陷 / 重构 -- 所属 Epic:# -- 所属 MVP / 版本:# -- 状态:待验收 / 已完成 +- 类型:重构 +- 状态:待验收 - 日期:2026-08-18 - Gitea 工单:https://git.ilapage.cn/OPC/dev_harness/issues/23 - Wiki 页面:Task-23-合并dev_scripts入口 -- Wiki revision:见本地镜像头 ## 背景与目标 - +`dev_scripts/` 原有 4 个命令行入口加 1 个共享库。4 个入口需要在 8 处文档分别描述和记忆; +同步核心镜像还必须按顺序执行 3 条命令。目标是合并为单一入口并把三步合并为一条命令。 ## 最终方案 - +新建 `dev_scripts/harness.py`,argparse 子命令: + +| 子命令 | 来源脚本 | 参数 | +|---|---|---| +| `check` | check_harness.py | `--strict` | +| `sync` | sync_wiki_docs.py | `--check`、`--verify` | +| `archive` | new_task_archive.py | `<编号> <短标题>` | +| `export` | export_task_archives.py | `--all` | + +各命令实现逻辑按标记从原文件整段切出,逐字保留,只重装入口;`wiki_docs.py` 未改动。 +新增的 `sync --verify` 依次执行 导出 → `check --strict` → 一致性校验,任一步失败即停止。 + +4 个旧入口已删除,不保留兼容转发(用户确认)。这是破坏性变更。 + +与建单方案的差异:建单时列出 6 个受影响 Wiki 页面,实施时核实为 7 个, +遗漏的是 Architecture-and-Code-Map(代码地图中三行入口函数和参数需要改写为子命令)。 ## 修改文件 -- `<文件>`:<改动说明> +- 新增 `dev_scripts/harness.py`:单一命令行入口,725 行。 +- 删除 `dev_scripts/check_harness.py`、`sync_wiki_docs.py`、`new_task_archive.py`、`export_task_archives.py`。 +- `dev_scripts/harness.py` 的 `REQUIRED_FILES` 与 `check_repository_readme` 门禁命令同步更新。 +- `tests/test_harness_docs.py`、`tests/test_wiki_docs.py`:import 来源与 patch 目标改为 harness,用例断言未变。 +- `AGENTS.md`、`README.md`:命令改写,三步序列改为 `sync --verify`,目录清单更新。 +- 7 个核心 Wiki 页面及其 `docs/` 镜像。 + +## Wiki revision + +| 页面 | revision | +|---|---| +| Project-Profile | `dae88cec8177` | +| Development-Workflow | `d6afa1cba5cd` | +| Architecture-and-Code-Map | `5c8801853ca8` | +| Local-Development-and-Verification | `b519184a1f0a` | +| Common-Changes | `f3bc14df51d0` | +| New-Project-Documentation-Setup | `e186d7119620` | +| Home | `9eeda7d498ed` | ## 验收结果 | 验收标准 | 结果 | |---|---| -| | 通过 / 未通过 | +| `dev_scripts/` 下只剩 harness.py 与 wiki_docs.py | 通过 | +| 四个子命令行为与原脚本一致 | 通过,逻辑整段切出未改写,40 个原有用例全部通过 | +| `sync --verify` 一条命令完成原三步 | 通过 | +| `harness.py check --strict` | 通过 | +| `unittest discover -s tests -v` | 通过,Ran 40 tests,OK | +| `harness.py sync --check` | 通过 | +| AGENTS.md、README.md 及 Wiki 页面不再出现旧脚本名 | 通过,仅 harness.py 文件头保留来源说明 | +| Wiki 已更新并回读 revision,镜像已导出 | 通过,7 页全部回读 | ## 测试 -- 执行命令:`<命令>` -- 结果: -- **未验证部分**: +- 执行命令:`python dev_scripts/harness.py check --strict` +- 结果:DevHarness 检查通过 +- 执行命令:`python -m unittest discover -s tests -v` +- 结果:Ran 40 tests,OK +- 执行命令:`python dev_scripts/harness.py sync --verify` +- 结果:Wiki 镜像同步完成 → DevHarness 检查通过 → Wiki 镜像检查通过,退出码 0 +- 执行命令:`python dev_scripts/harness.py archive 23 "合并dev_scripts入口"` +- 结果:成功创建本归档页 +- **未验证部分**:`export` 与 `export --all` 只有单元测试覆盖,本次未对线上任务归档做真实增量导出, + 因为导出必须由用户明确提出。下游业务项目升级后的命令兼容性也未验证,属于采用方职责。 ## 遗留问题 - +- `harness.py` 合并后 725 行,单文件偏长。当前按「结构检查 / 任务归档 / 归档导出 / 子命令入口」 + 四段分区,如后续继续增长可再考虑拆分为库模块。 +- `docs/task/` 下历史归档快照仍记录旧脚本名,属历史事实,未回改。 ## 相关提交 -- `<提交哈希>` <提交说明> +- `bfc0726` refactor: 合并 dev_scripts 入口为单一 harness.py (#23) +- `bfdf648` docs: 同步命令入口变更的核心 Wiki 镜像 (#23)