Documentation

Getting started

ReleasePilot connects to your GitHub repositories and generates release notes automatically every time you push code. This guide covers everything you need to get started.

What you need

A GitHub account
At least one repository you have admin access to
That's it. No GitHub Actions, no workflow files, no CLI.

Connect GitHub

ReleasePilot uses GitHub OAuth for authentication. Click "Start free with GitHub" on the homepage and authorise the ReleasePilot application. You will be redirected to your dashboard.

Permissions requested

  • — repo — to register webhooks on your repositories
  • — read:user — to read your GitHub username
  • — user:email — to read your email address

We never read your source code. We only receive commit messages via push webhooks.

Connect a repository

From your dashboard, click "Connect Repository". A list of your GitHub repositories will appear. Select the repository you want to connect.

ReleasePilot will automatically register a webhook on that repository. You will see a confirmation once the connection is established.

Note

You must have admin access to a repository to connect it. Repositories where you only have write or read access will not appear in the list.

Repository dashboard

Your dashboard shows all connected repositories. Each card displays the repository name, total release count, and a preview of the latest generated release notes.

To disconnect a repository, click "Remove" on its card. This deletes the webhook from GitHub and removes all changelogs from our database.

Public changelog

Every connected repository gets a public changelog page at:

/changelog/your-github-username/repository-name

This page is accessible to anyone with the link. Share it with your users, add it to your README, or link to it from your product.

Pricing

Free

  • — 1 repository
  • — Unlimited releases
  • — Public changelog page

Pro — ₹499/month

  • — Unlimited repositories
  • — Priority processing
  • — Custom branding

FAQ

What happens when I push a commit?

GitHub sends a push event to ReleasePilot. ReleasePilot extracts the commit messages, formats them into structured release notes, and saves them to your changelog.

Can I use private repositories?

Yes. ReleasePilot works with any repository you have admin access to.

How do I disconnect a repository?

From your dashboard, click Remove on the repository card. The webhook is deleted from GitHub and all changelogs are removed.

Can I edit generated release notes?

Release note editing is planned for a future update. Currently, changelogs are generated and published automatically.

What if a push has no meaningful commits?

ReleasePilot skips merge commits and very short commit messages. If a push contains only these, no changelog is generated.