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/MDX grouped by year -> month -> category -> 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, then curate over time.
I’m curious what works for you in practice:
- Towncrier?
- reno?
- GitHub Releases / auto-generated notes?
- something else?
What do you like/hate about your current setup? Any tools you’d recommend?
If anyone wants to see the script I wrote, I am happy to share it and would love some constructive feedback.
cpburns2009•21h ago
dustfinger•21h ago
I am also planning to add some PR templates so contributors include the context up front, which should make any release note generation more accurate.
Are you using any tooling to help with changelog curration? I know towncrier is all about fragments, so contributors must had write a brief summary of their contribution, which would be more in-line with your preference.
pancsta•20h ago
dustfinger•20h ago
One thing I am trying to do is make the generator surface breaking/migration items explicitly, but I still think anything that requires human judgment (migration steps, caveats) should be hand-curated in a dedicated document like you suggested.