Skip to content

docs: API 4 调试适配器插件的发布说明,并同步 README 总览 - #29

Merged
xiaoyumuxi merged 2 commits into
mainfrom
docs/api-4-publishing
Oct 26, 2026
Merged

xiaoyumuxi merged 2 commits into
mainfrom
docs/api-4-publishing

Conversation

@xiaoyumuxi

Copy link
Copy Markdown
Collaborator

把 API 4(调试适配器插件)在 Lithe Store 一侧的文档补齐,并把落后的 README 总览同步到当前索引。

改动

  • docs/publishing.md:
    • 补充 API 4 版本项的 requires 写法:Core 对 API 3 以上的索引项允许省略,提供时仍校验;建议像 API 3 一样逐项复制包内的 requires,让旧宿主仍能选到可安装版本。
    • 新增"预发布转正"流程:稳定版 Lithe 支持 API 4 之前,调试适配器插件保持 GitHub 预发布并提交手工索引条目(tracker 只收正式 Release);支持之后转正,tracker 自动提交后续版本。链接到 lithe-plugin-docs 的调试适配器插件指南(该指南的 PR 合并前链接会 404)。
  • scripts/validate-index.mjs:只改注释,说明"API 3 以上才要求/校验 requires",行为不变。
  • README.md:重新运行 node scripts/render-readme.mjs,补上 Database 0.1.1 和 LLDB Debugger 0.1.0(feat(index): 收录 LLDB Debugger 0.1.0 预发布插件 #28 合并后总览一直没更新)。

为什么 README 要手动同步

Sync README 工作流从 #25 起直接推送 main 被保护规则拒绝(GH013),总览因此落后。本 PR 只是补一次;工作流本身怎么处理(改成自动开 PR,或给它加规则豁免)需要仓库管理员决定,不在本 PR 范围。

验证

  • node scripts/render-readme.mjs --check 通过
  • node scripts/validate-index.mjs:9 个插件有效
  • node --test scripts/*.test.mjs:46 个测试通过

publishing.md 补充 API 4 的 requires、预发布到稳定版支持后的转正,并链到 lithe-plugin-docs 的调试适配器指南;validate-index.mjs 的注释不再把 API 4 称作未来等级。不改校验行为。
@xiaoyumuxi
xiaoyumuxi merged commit bf28479 into main Oct 26, 2026
1 check passed
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