Getting Started

Click "Login with GitHub" on the homepage. This authorizes KittyLog to access your repositories.

Go to the Repositories page and click "Connect" on any repository you want to generate changelogs for.

Choose your generation mode, target audience, and language. KittyLog will automatically generate changelogs based on your settings.

Common Patterns to Ignore

How It Works

When a tag or release matches any of your ignore patterns, KittyLog will skip changelog generation entirely. Pattern matching is case-insensitive and checks if the pattern appears anywhere in the tag name.

On Connect

When you connect a new repository in Release or Tag mode, KittyLog will offer to generate changelogs for existing releases or tags.

From Repository Page

Visit your repository's detail page and expand the "Generate Changelogs" section. Select past releases, tags, or time periods (depending on your mode) and generate changelogs for them.

Webhook Events

KittyLog listens to these GitHub webhook events:

• release - Detects published GitHub Releases
• create - Detects new tags (git refs)
• push - Detects commits for scheduled mode

Hosted Changelogs

Changelogs are hosted on KittyLog at kittylog.app/c/owner/repo. You can optionally configure a custom domain for your changelog.

Permissions Required

• Read access to code and commits
• Read access to metadata and releases
• Write access to contents (only if auto-commit is enabled)

Notification Events

• ✓Changelog Generated - When a new changelog is successfully created
• ✗Generation Failed - If something goes wrong during generation (email only)
• !Quota Warning - When you're approaching your monthly generation limit (email only)

Email Notifications

Email notifications are available on all plans. By default, notifications are sent to your GitHub email address.

Discord Notifications

Get changelog updates sent directly to your Discord server with rich embeds showing the repository, version, and summary.

Per-Changelog Overrides

You can customize notification settings for individual changelogs. For example, you might want to disable notifications for a frequently-updated test repository while keeping them enabled for your main project.

Configure overrides in each changelog's settings page under the "Notifications" tab.

Setup Steps

1. Go to your repository settings and expand the Custom Domain section
2. Enter your domain (e.g., changelog.yoursite.com)
3. Add the DNS records shown to your domain provider
4. Click "Verify DNS Configuration" once your DNS has propagated

DNS Records Required

SSL/HTTPS

SSL certificates are automatically provisioned for verified custom domains. Your changelog will be accessible via HTTPS once DNS verification is complete.