Automating release notes and changelog generation #1285
-
|
Hey nuqs team, been following your release cadence and noticed you're maintaining consistent updates. One thing I've seen a lot of maintainers struggle with is the manual overhead of writing release notes and CHANGELOGs each time. Would be curious if this is something you face too? There's been some interesting progress on tools that auto-generate release notes from commits and PRs. It could free up time to focus on the actual development work. Currently exploring this space via https://devion.dev and would love your feedback on what an ideal solution might look like for a project like nuqs. The platform is in demo mode so your input would be really valuable. |
Beta Was this translation helpful? Give feedback.
Replies: 2 comments
-
|
Thanks for reaching out, we have automation to generate release notes on GitHub Releases, and a PR to add that to the docs is on the way. I've seen countless AI-based tools get a lot of these things wrong, which is problematic since changelog are a form documentation, and documentation should be correct before anything else. Also, since changelog generation is a deterministic process, I don't think it needs an LLM, that's just a waste of compute. |
Beta Was this translation helpful? Give feedback.
-
|
@franky47 thanks for the honest feedback - this is exactly the kind of input we need in demo mode You're absolutely right that accuracy is paramount for documentation. Your point about deterministic processes is interesting because we actually take a hybrid approach: 1.Deterministic foundation - We parse commits, PRs, and metadata (not relying on LLMs for core logic) The way we see it: automation should handle the repetitive structural work (collecting changes, grouping by type, formatting), while maintainers review/edit before release. LLMs are only useful for polish, not for determining "what changed." Since you already have automation in place, Devion might not be the fit for nuqs right now. But we'd love to learn what works well about your current approach, that helps us iterate toward tools that respect maintainers' standards. Thanks again for thinking through this carefully! |
Beta Was this translation helpful? Give feedback.
Thanks for reaching out, we have automation to generate release notes on GitHub Releases, and a PR to add that to the docs is on the way.
I've seen countless AI-based tools get a lot of these things wrong, which is problematic since changelog are a form documentation, and documentation should be correct before anything else. Also, since changelog generation is a deterministic process, I don't think it needs an LLM, that's just a waste of compute.