Skip to content

docs(release): 把版本号从发布流程里抽掉,发 core 不必再改文档 - #27

Closed
yandy wants to merge 1 commit into
mainfrom
docs/release-2.3.0
Closed

yandy wants to merge 1 commit into
mainfrom
docs/release-2.3.0

Conversation

@yandy

@yandy yandy commented Nov 17, 2026 •

Copy link
Copy Markdown
Owner

上一版(本分支的第一个 commit)只是把示例里的 2.2.0 逐个换成 2.3.0 —— 治标:每发一个 core
版本都得回来改一次文档,忘了改就把下一个人指向一个过时版本。这一版改成版本无关。

改法

  • 版本与范围统一用 <新版本号> / <范围> 占位,并写明 memory-core/package.json 的 version 是
    唯一真相源,本文件不复制这个数字 → 发新 core 只需 bump 版本与范围,不用回头改文档。
  • 删掉「哪些 API 从哪版起」的版本清单(createSyncRuntime 2.2.0 / pathConfigErrors 2.3.0 之类),
    换成一条稳定规则:适配层 import 的每个 core 导出都必须存在于它声明的范围里;core 新增导出时
    先发 core、再抬范围。
  • registry-smoke 的硬失败例子保留真实报错的形态,但不再绑定版本叙事:
    • 范围整个不存在 → No matching version found for @yandy0725/memory-core@<范围>
    • 导出了新东西而 core 没发 → SyntaxError: ... does not provide an export named '<导出名>'
  • 验收用的 curl 也用占位符。

全文现在没有 2.2.0 / 2.3.0 / 4.3.1 这类会过期的数字(grep 为空);唯一保留的 memory-core-v1.0.0
是 tag 格式示例,与当前版本无关。

为什么不用「文档 + 检查脚本」

可以用脚本比对文档里的版本与 package.json,但那是给「必须写数字」的方案打补丁。流程文档里本来就不需要
当前版本号 —— 读者要看的是规则和命令形态,具体版本从 package.json 拿。少一个维护点,也少一种 CI 失败。

纯文档改动。

上一版(同一分支的前一个 commit)只是把示例里的 2.2.0 逐个换成 2.3.0 —— 治标:每发一个 core
版本就得改一次文档,忘了改就把人指向一个过时版本。

- 版本与范围统一用 `<新版本号>` / `<范围>` 占位,并写明 `memory-core/package.json` 的 `version`
  是唯一真相源,**本文件不复制这个数字**。
- 去掉「哪些 API 从哪版起」的版本清单,换成稳定规则:适配层 import 的每个 core 导出都必须存在于
  它声明的范围里;core 新增导出时先发 core、再抬范围。
- `registry-smoke` 的硬失败例子保留真实报错的**形态**,但不再绑定版本叙事:
  范围不存在 → `No matching version found`;导出了新东西而 core 没发 →
  `does not provide an export named '<导出名>'`。
- 验收 curl 同样用占位符。

全文已无 2.2.0 / 2.3.0 / 4.3.1 这类易变数字。
@yandy
yandy force-pushed the docs/release-2.3.0 branch from b2f3dce to f6ff484 Compare November 17, 2026 10:41
@yandy yandy changed the title docs(release): release.md 跟上 core 2.3.0 与适配层的 ^2.3.0 docs(release): 把版本号从发布流程里抽掉,发 core 不必再改文档 Nov 17, 2026
@yandy

yandy commented Nov 17, 2026

Copy link
Copy Markdown
Owner Author

并入 #28(文档整体精简:去英文镜像 + 去历史 + 版本无关)。本分支的 release.md 改动已 cherry-pick 进 #28。

@yandy yandy closed this Nov 17, 2026
@yandy
yandy deleted the docs/release-2.3.0 branch November 17, 2026 11:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant