Documentation menu

Connect a GitHub repo

Connecting a repository is the only setup ChangelogPilot needs. Once a repo is connected, every pull request you merge becomes a draft changelog entry automatically.

Before you start

  • You need a GitHub account with admin access to the repository you want to connect. Teammates get access by invitation once it's connected — see Teams and members.
  • The Free plan includes one connected repository; Pro allows up to three.

Sign in

Go to the sign-in page and enter your email address. We send you a magic link — there is no password to create or remember, and the same flow covers new and returning users. The link expires after 15 minutes and works once; if it has expired, just request another.

Connect your GitHub account

The first time you sign in, onboarding asks you to authorise ChangelogPilot with GitHub. We request the repo and read:user scopes only — enough to read your repositories and see who you are.

If you use more than one GitHub account, sign into the one you want on GitHub first — GitHub applies the authorisation to whichever account is signed in there. You can disconnect and connect a different account at any time; anything you've already connected or published is kept.

Pick the repository

Choose the owner (your user or an organisation) and the repository from the picker, which lists the repositories your GitHub account can see. Then:

  • Watched branch. Drafts are generated when a pull request merges into this branch. It defaults to the repository's default branch, which is right for most repos.
  • Automatic drafts. On by default: every merged pull request becomes a draft for you to review.
  • Auto-publish. Off by default. When it's on, drafts publish without review — read How drafts are generated before turning this on.

ChangelogPilot verifies it can see the repository, then registers a webhook so merged pull requests flow in from that point on.

Choose a plan

After your first repo connects you pick Free or Pro. Free needs no credit card, and you can change your mind later — upgrading and downgrading are both self-serve.

That is it — the next pull request you merge will appear as a draft entry, ready to review. See Publish your first entry.

Starting with history

A brand-new changelog does not have to start empty. From the repo's settings you can backfill recently merged pull requests, so your page launches with real entries instead of a blank timeline. On Free the backfill covers roughly the last 30 days (up to 10 entries); on Pro you can import your full history.

Adding more repos

You can connect additional repositories from the app at any time, within your plan's limit — one on Free, three on Pro. Each repo gets its own changelog page, drafts, and settings.