Skip to content

ci(track): 追踪新版本的 PR 同时重新生成 README 总览 - #31

Merged
xiaoyumuxi merged 1 commit into
mainfrom
ci/track-releases-render-readme
Oct 26, 2026
Merged

xiaoyumuxi merged 1 commit into
mainfrom
ci/track-releases-render-readme

Conversation

@xiaoyumuxi

Copy link
Copy Markdown
Collaborator

#30 把 Sync README 改成了 bot PR,所以每次追踪到新版本、合并索引 PR 之后,还会多出一个只含 README 的同步 PR。本 PR 让追踪工作流在同一个提交里一并重新生成 README,一次合并覆盖索引和总览。

改动

  • .github/workflows/track-releases.yml:提交 bot/track-releases 前先运行 node scripts/render-readme.mjs,提交里同时包含 lithe-plugin-index.json 和 README.md;PR 描述补一句“README 总览已一并重新生成”。
  • docs/maintainers.md:自动追踪一节说明 PR 同时包含索引和 README,合并后不需要再等 Sync README。

不变的部分

  • Sync README 保留,仍负责手工提交的索引 PR(例如 feat(index): 收录 LLDB Debugger 0.1.0 预发布插件 #28 这类预发布条目)、渲染脚本和图片的更新。追踪 PR 合并后它会运行一次,发现 README 已经一致就结束。
  • 追踪的校验步骤(--verify-archives --base)没有改动。

验证

  • node scripts/render-readme.mjs 在当前 main 上不产生差异;node --test scripts/*.test.mjs 46 个通过。
  • actionlint 对 track-releases.yml 只有一条 SC2086 提示,指向“Find new releases”步骤里原本就有的 $args,不是本 PR 引入。
  • 追踪工作流只能在 main 上由定时任务或手动触发,合并后下一次出现新版本时才会走到这条路径;也可以合并后手动运行一次 Track plugin releases 观察。

main 受保护,Sync README 只能在合并后再开一个 PR。追踪工作流在提交索引前
先渲染 README,让一次合并同时覆盖索引和总览。
@xiaoyumuxi
xiaoyumuxi merged commit bd793d4 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