How does AutoChangelog work?

AutoChangelog integrates with your GitHub repository and automatically generates changelog entries from your pull requests. When you merge a PR, our AI analyzes the changes and creates a clear, user-friendly changelog entry. You can review and publish entries from your dashboard.

Do I need to write changelogs manually?

No! That's the whole point. AutoChangelog reads your pull requests and generates changelog entries automatically using AI. You can review and edit them before publishing, but you never have to start from scratch.

What information does AutoChangelog use to generate entries?

AutoChangelog analyzes your PR title, description, code changes, and any related commits. Our AI then transforms this technical information into clear, user-friendly language that explains what changed and why it matters.

Can I edit the generated changelogs?

Yes! Every generated entry can be reviewed and edited before publishing. You have complete control over what gets published to your changelog.

What's the difference between draft and auto-publish?

In draft mode, generated entries are saved as drafts for you to review before publishing. With auto-publish enabled, entries are published immediately when generated. You can choose either mode per repository in your settings.

Which GitHub plan do I need?

AutoChangelog works with any GitHub plan, including free accounts. As long as you can create pull requests in your repository, AutoChangelog can generate changelogs for them.

Can I use AutoChangelog with private repositories?

Yes! AutoChangelog works with both public and private GitHub repositories. We securely access your repository through GitHub OAuth with the permissions you grant.

How many repositories can I connect?

The Free plan supports 1 repository. The Pro plan supports 1 repository with unlimited PR processing. The Team plan supports unlimited repositories with unlimited PR processing.

What happens if I exceed my plan's PR limit?

On the Free plan, you get 10 AI-generated changelogs per month. Once you reach this limit, new PRs won't generate changelog entries until your limit resets (monthly) or you upgrade to a paid plan.

Can I export my changelogs?

Your changelog entries are available via a public changelog page at autochangelog.com/c/[your-repo]. Each entry is written in Markdown and can be easily copied or accessed via our API.

How do I share my changelog with users?

Every repository gets a public changelog page at autochangelog.com/c/[your-repo]. You can link to this from your website, documentation, or GitHub repository. Pro and Team plans will support custom domains soon.

What happens to my changelogs if I cancel?

All your published changelogs remain accessible even after cancellation. You'll have a 7-day grace period where everything continues working. After that, repositories exceeding the free tier limit will be disabled, but your changelog data is never deleted.

Can I customize the changelog format?

Currently, AutoChangelog uses a clean, consistent format optimized for readability. Custom templates and formatting options are planned for future releases. You can always edit individual entries to match your style.

Documentation

Everything you need to know about using AutoChangelog to create beautiful, AI-assisted changelogs for your projects. From setup to customization, we've got you covered.

Getting Started

Learn how AutoChangelog works and set up your first repository

GitHub Integration

Connect your repositories and understand the permissions we need

How Entries Are Generated

What happens behind the scenes when AI generates your changelog

CI/CD Integration

Trigger changelog generation from GitHub Actions or any CI/CD pipeline

Webhook API

API reference for triggering changelog generation via webhooks

Customizing Templates

Change colors, fonts, and styles to match your brand

Embedding Your Changelog

Add a changelog widget or in-app notification bubble to your site

Custom Domains

Host your changelog on your own domain like changelog.yourapp.com

Plans & Billing

Compare plans and manage your subscription

FAQ

Answers to common questions about AutoChangelog

Need more help?

Can't find what you're looking for? Reach out to us at hello@autochangelog.com