Skip to content

Commit 173c7a2

Browse files
XXPermanentXXXXPermanentXX
committed
docs: improve formatting in changelog-write.md and publish.md for better readability
1 parent fddab1a commit 173c7a2

2 files changed

Lines changed: 24 additions & 24 deletions

File tree

‎docs/agents/changelog-write.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -178,9 +178,9 @@ git show <commit> --stat
178178

179179
## 与 publish.md 的边界
180180

181-
| 文档 | 管什么 |
182-
| -------------------------- | ---------------------------------------------------- |
183-
| [publish.md](publish.md) | 发布流程:自检 / 构建 / npm publish（CI 驱动） |
184-
| 本文档 | 发版后写说明:面向用户的 release notes |
181+
| 文档 | 管什么 |
182+
| ------------------------ | --------------------------------------------- |
183+
| [publish.md](publish.md) | 发布流程:自检 / 构建 / npm publish（CI 驱动） |
184+
| 本文档 | 发版后写说明:面向用户的 release notes |
185185

186186
两者顺序:`publish.md` → npm publish → 本文档(更新 `CHANGELOG.md` + `CHANGELOG_CN.md`)→ 推到 GitHub。

‎docs/agents/publish.md‎

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313

1414
两种模式：
1515

16-
| 模式 | 用途 | 触发方式 |
17-
| ------- | ----------------------------- | ------------------------------------------------- |
16+
| 模式 | 用途 | 触发方式 |
17+
| ------- | ------------------------------ | -------------------------------------------------- |
1818
| channel | 发 channel 版本到指定 dist-tag | 选 mode=channel，填 dist-tag 名称（如 mcp/plugin） |
1919
| stable | 正式发版到 latest | 选 mode=stable，需 production environment 审批 |
2020

@@ -36,16 +36,16 @@
3636

3737
两种模式都会先跑 `check.mjs`，覆盖以下检查：
3838

39-
| 检查项 | 说明 |
40-
| ---------------------------- | ------------------------------------------- |
41-
| `pnpm install --frozen-lockfile` | lockfile 一致性 |
42-
| README 同步 | `packages/cli/README.md` 与根 README 一致 |
43-
| 版本号一致 | cli 与 core 的 version 字段相同 |
44-
| `workspace:*` 替换 | cli 对 core 的依赖解析为真实版本号 |
45-
| 构建 core + cli | `pnpm build` |
46-
| pnpm pack | 打 tarball |
47-
| publint | 包元数据校验 |
48-
| gitleaks | 敏感信息扫描 |
39+
| 检查项 | 说明 |
40+
| -------------------------------- | ----------------------------------------- |
41+
| `pnpm install --frozen-lockfile` | lockfile 一致性 |
42+
| README 同步 | `packages/cli/README.md` 与根 README 一致 |
43+
| 版本号一致 | cli 与 core 的 version 字段相同 |
44+
| `workspace:*` 替换 | cli 对 core 的依赖解析为真实版本号 |
45+
| 构建 core + cli | `pnpm build` |
46+
| pnpm pack | 打 tarball |
47+
| publint | 包元数据校验 |
48+
| gitleaks | 敏感信息扫描 |
4949

5050
本地可以 dry-run 验证：
5151

@@ -81,11 +81,11 @@ node tools/release/publish-channel.mjs --channel test --dry-run
8181

8282
## 常见漏点（基于历史踩坑）
8383

84-
| 漏点 | 后果 |
85-
| ------------------------------------------------ | ---------------------------------------------------- |
86-
| cli 升版号但 core 没升 | check.mjs 会拦下 |
87-
| `1.0.0` 当 beta 直接发 | 占了 `latest` tag，所有用户被强升，撤回成本极高 |
88-
| README 写的 bin 名实际 `package.json.bin` 没注册 | 用户复制命令报 `command not found` |
89-
| Node 徽章 `>=18`、engines `>=22.12` 不一致 | 用户在 Node 18 上 `npm i` 被 engine 警告或直接失败 |
90-
| npm Trusted Publisher 的 workflow filename 改了没同步 | OIDC 匹配不上，publish 报 404 |
91-
| CI 用 Node 22（npm 10）跑 publish | npm 10 不支持 OIDC token 交换，publish 报 404 |
84+
| 漏点 | 后果 |
85+
| ----------------------------------------------------- | -------------------------------------------------- |
86+
| cli 升版号但 core 没升 | check.mjs 会拦下 |
87+
| `1.0.0` 当 beta 直接发 | 占了 `latest` tag，所有用户被强升，撤回成本极高 |
88+
| README 写的 bin 名实际 `package.json.bin` 没注册 | 用户复制命令报 `command not found` |
89+
| Node 徽章 `>=18`、engines `>=22.12` 不一致 | 用户在 Node 18 上 `npm i` 被 engine 警告或直接失败 |
90+
| npm Trusted Publisher 的 workflow filename 改了没同步 | OIDC 匹配不上，publish 报 404 |
91+
| CI 用 Node 22（npm 10）跑 publish | npm 10 不支持 OIDC token 交换，publish 报 404 |

0 commit comments

Comments
 (0)