GitHub Integration

KittyLog connects through the GitHub App install flow — no tokens to manage or webhooks to configure manually. Everything is set up automatically when you connect a repository.

Permissions

Review the permissions on GitHub before installing. The current app requests the following access. These permissions grant capabilities; they do not turn on every delivery option. Automatic CHANGELOG.md delivery and reviewed GitHub Release creation are off by default for new repositories. Existing repositories retain their settings. Check Overview → Generation → CHANGELOG.md sync before enabling automation: generation can write a review draft to a GitHub PR before it is published on KittyLog. Manual approval controls hosted publication, not all repository writes:

  • Contents (read and write) — read commits, tags and changed files; optionally update CHANGELOG.md by pull request or direct commit, or publish notes to GitHub Releases
  • Metadata (read) — identify repositories
  • Pull requests (read and write) — read referenced PR context and open or update optional CHANGELOG.md pull requests
  • Issues (read) — read referenced issue context
  • Email addresses (read) — obtain your sign-in email address

Webhook Events

With Automatic timing, new tags drive Tag mode and scheduled generation checks for new commits when its run starts. Manual timing waits for your generation request:

  • create — new git tags (Tag mode)
  • push — force pushes invalidate cached commit history; ordinary pushes are ignored by this handler

The app also subscribes to GitHub Release events, but the current receiver ignores them. Publishing notes to a GitHub Release is a separate optional feature.

Hosted Changelog Page

Every connected repo gets a hosted changelog at kittylog.app/c/owner/repo. Enable Hosted URL visibility in Sharing to make it public, then share the link or add a README badge. On the Business plan, readers can translate any changelog into one of 16 supported languages on-demand. You can also point a custom domain at it (see Custom Domains).

CHANGELOG.md Sync

Every plan can keep release notes in the repository through a pull request. Open your repository's Overview tab and find CHANGELOG.md sync. Choose Create CHANGELOG PR to export published entries, or Regenerate CHANGELOG PR if you closed a previous PR without merging.

Auto-deliver CHANGELOG after generation is off by default. Review the delivery behavior before enabling it: Pull request is the default method, and the delivery choices appear after you enable the toggle. Scheduled delivery exports published entries after generation. This is not a promise to sync every generation or every publication.

Existing repositories with automatic tag delivery enabled can include a newly generated review draft in a PR before it is published on KittyLog. That older tag setting is separate from the current Auto-deliver toggle; the toggle does not enable or disable it. If you previously enabled tag delivery, confirm its status with support before relying on the toggle to prevent writes. Creating or updating a PR already writes to a repository branch and can trigger GitHub workflows. Review the PR in GitHub before merging.

Commit directly to the configured or default branch is a separate choice that requires repository admin permission. It can write published entries without a PR, subject to branch protections, and may trigger CI or deployments. A tag draft requiring review uses a PR instead. Manual approval on KittyLog is not a guarantee of no GitHub writes. For an explicit export after review, publish on KittyLog and then choose Create CHANGELOG PR; check existing automation settings first.

Generation creates the entry; the publishing policy controls when it becomes published on KittyLog; GitHub delivery is a separate action. Ordinary Publish does not itself create a CHANGELOG PR. With Create reviewed GitHub Releases enabled, use the Release packet dialog for reviewed release delivery. The separate Publish to GitHub Releases toggle can send tag notes on publication when the reviewed workflow is off. Check both settings before publishing.

The GitHub App needs permission to write repository contents and pull requests. Review the permissions and controls before granting access. If GitHub requests updated permissions, review them before deciding whether to approve and retry sync.