The Changelog Guide
Everything you need to know about changelogs, release notes, and product communication — from basics to advanced workflows.
Basics
What Is a Changelog?
Definition, structure, and best practices for maintaining a changelog that your users actually read.
How to Write Release Notes
A practical guide to writing release notes that your users will actually read — with examples, templates, and tips for different audiences.
Semantic Versioning (SemVer) Explained
Understand MAJOR.MINOR.PATCH versioning, when to bump which number, and why SemVer matters for your changelog and your users.
Changelog vs. Release Notes
They sound similar but serve different purposes. Learn when to use a changelog, when to write release notes — and why the best teams do both.
Keep a Changelog — The Format Explained
The popular Keep a Changelog format gives your project a standardized, human-readable change log. Learn the principles, types, and common anti-patterns.
Workflows
Automate Your Changelog
Stop writing changelogs manually. Learn how to use conventional commits, CI/CD pipelines, and APIs to automate your changelog workflow.
How to Embed a Changelog in Your Website
Three ways to add a changelog to your site — widget, API, or iframe. Compare effort, control, and performance for each approach.
Release Communication — How to Inform Users About Updates
A complete guide to release communication: channels, timing, templates, and common mistakes to avoid.
API Changelog — Why Breaking Changes Must Be Documented
How to document API changes, handle breaking changes responsibly, and maintain developer trust through transparent communication.
Strategy
Tutorials
Changelog Widget Tutorial — Step by Step
Add a 1.8KB changelog widget to your website in under 5 minutes. Customize position, theme, and colors to match your brand.
Changelog API Tutorial — Create Entries Programmatically
Use the Deplyd REST API to publish changelog entries from your CI/CD pipeline, Slack bot, or any custom tool.
Custom Domain for Your Changelog
Run your changelog on your own domain like changelog.yourapp.com. Step-by-step DNS setup, SSL, and branding benefits.
Ready to ship your changelog?
Deplyd gives you everything you need — widget, API, email notifications, and custom domains.
Get started free