ChangelogPilot docs
ChangelogPilot writes your changelog from work you have already done. Connect a GitHub repository and every merged pull request becomes a draft changelog entry, written in plain English — the way you would explain the change to a customer, not the way a commit message reads. You review it, approve it, and publish. Nothing goes public without your say-so.
How it works
- Connect a GitHub repo. Sign in, connect your GitHub account, and pick the repository you want a changelog for. See Connect a GitHub repo.
- Merge pull requests as usual. ChangelogPilot watches your merged PRs and drafts an entry for each one. No new workflow, no changelog file to maintain in the repo.
- Review, approve, publish. Each draft is a quick review, not a writing task. Edit if you like, approve, and publish. See Publish your first entry.
What you get
- A hosted changelog page with a clean URL you can link from your app or docs — no deploy step, no embed configuration. See Your changelog page.
- RSS and Atom feeds with full entries, so readers and tools can follow along.
- A writing voice you choose. Pick a voice persona so entries sound like you, consistently. See Changelog voice.
- On the Pro plan: your own domain and branding, email subscriptions for your readers, an embeddable widget, a read API with outbound webhooks, and full analytics. See Plans and billing.
Where to start
If you are new, start with Connect a GitHub repo — you can go from signing up to a published changelog in a few minutes. When you want to tune what gets drafted, How drafts are generated covers the triggers, filters, and digests.
Getting started
- What is ChangelogPilot?
ChangelogPilot turns your merged GitHub pull requests into customer-ready changelog entries. You review and approve; it publishes to a hosted page.
- Connect a GitHub repo
Sign in to ChangelogPilot, authorise GitHub, and pick the repository you want a changelog for.
Publishing
- Publish your first entry
How to review, edit, and publish a draft changelog entry — from the dashboard or straight from the draft-ready email.
- How drafts are generated
What ChangelogPilot does with a merged pull request — how entries are written, what gets filtered out, and the triggers you can configure.
- Your changelog page
The hosted public changelog page every repo gets — its URL, layout, feeds, and the ways you can make it yours.
Customise
- Themes and branding
Colour themes for your public changelog page on every plan, and custom colours, your logo, and badge control on Pro.
- Custom domain
Serve your changelog from your own subdomain on Pro — how to point the DNS, prove ownership, and what happens to the platform URL.
- Changelog voice
Pick a writing persona on any plan, and tune industry vocabulary and voice DNA — structure, tone, and locale — on Pro.
Distribute
- Reader subscriptions
Let readers subscribe to your changelog by email on Pro — double opt-in, one email per entry, one-click unsubscribe.
- The embeddable widget
Put a "What's new" button with an unread dot inside your own app on Pro — one script tag, themed to your brand.
- Analytics
Who's reading your changelog — views over time, top entries, referrers, and AI-crawler traffic, without tracking your readers.
Developers
- Read API and webhooks
Fetch your published entries as JSON and get a signed webhook on every publish — the Pro developer surface.
Account
- Teams and members
Invite teammates to a repo's changelog, what each role can do, how seats are counted, and transferring ownership.
- Plans and billing
What Free and Pro include, the repo and seat limits, how upgrading works, and exactly what happens when you downgrade.