Ask HN:你们如何自动化生成发布说明?

2作者: dustfinger6 个月前
你们的项目中是如何生成发布说明的? 我刚为某个开源仓库补全了一年的文档发布说明。最后我写了一个基于发布标签的小型生成器:它遍历 Git 标签,收集发布之间的合并请求(PR),将它们归入不同类别,然后按年 -> 月 -> 类别 -> 版本的顺序渲染 Markdown/MDX。我还添加了一个可选的 LLM 步骤,通过 Pydantic 模式输出结构化的 JSON,用于包含每月摘要的 PR 列表。它是幂等的,并保留手动编辑或省略的内容,因此您可以自动生成,然后随着时间的推移进行整理。 我很想知道你们在实践中用什么: * Towncrier? * reno? * GitHub Releases / 自动生成的说明? * 其他的? 你们喜欢/讨厌目前的设置什么?有什么推荐的工具吗? 如果有人想看看我写的脚本,我很乐意分享,并希望得到一些建设性的反馈。
查看原文
How are you generating release notes in your projects?<p>I just had to backfill a year of docs release notes for an OSS repo. I ended up writing a small release tag driven generator: it walks git tags, collects merged PRs between releases, buckets them into categories, and renders Markdown&#x2F;MDX grouped by year -&gt; month -&gt; category -&gt; version. I also added an optional LLM step that outputs structured JSON via Pydantic schema for PR bullets that includes monthly summaries. It is idempotent and preserves manual edits or omissions, so you can auto-generate and then curate over time.<p>I’m curious what works for you in practice:<p>- Towncrier?<p>- reno?<p>- GitHub Releases &#x2F; auto-generated notes?<p>- something else?<p>What do you like&#x2F;hate about your current setup? Any tools you’d recommend?<p>If anyone wants to see the script I wrote, I am happy to share it and would love some constructive feedback.