Blog
Practical guides on writing changelogs and release notes, with templates and examples.
Release notes template (copy and paste, with examples)
A copy-and-paste release notes template with New, Improved, Fixed and Heads up sections, a filled-in example, and tips for writing each part.
Semantic versioning and your changelog: which number to bump
How Semantic Versioning and a changelog fit together: what to bump for each kind of change, how Keep a Changelog headings map to MAJOR, MINOR and PATCH.
How to create a public changelog page for your product
Learn how to build a public changelog page: why customers value it, what each entry should contain, where to host it and how to keep it up to date.
Changelog tools: 5 approaches and how to choose
Compare five ways to manage a changelog: a file, GitHub Releases, commit-driven tools, hosted pages and AI drafting, plus a checklist to choose.
What's new widget: add release notes inside your product
A What's new widget shows release news inside your product. Learn when to add one, what to write, how to pick a layout and how not to annoy users.
GitHub release notes automation: a step-by-step setup
Automate release notes on GitHub: generate them from merged pull requests, create releases from a tag workflow, group them with release.yml, and edit them.
What is a changelog? Definition, purpose and examples
A changelog is a dated list of the changes in each version of your software. See what it contains, what it is for, where to keep it and how to start one.
How to write a changelog (with examples)
A practical guide to writing a changelog people read: structure, six habits, and copyable changelog examples for users, developers and security fixes.
Changelog vs release notes: what is the difference?
A changelog is the dated record of every change per version. Release notes explain a release to users. See the differences, examples and when to use each.
Keep a Changelog template (copy and paste)
A copy-and-paste Keep a Changelog template, the six change types, how to use the Unreleased section, and how it works with Semantic Versioning.
Release notes generators: 5 ways to automate release notes
Compare 5 ways to automate release notes: by hand, git log, Conventional Commits tools, GitHub's generated notes and AI. What to check before you publish.