GitHub Integration
Commitloom integrates with GitHub via a GitHub App. This guide covers installation, required permissions, and configuration options.
Install the GitHub App
- Go to commitloom.com/login/signup.html and sign up (or sign in)
- From your dashboard, click Connect GitHub
- You'll be redirected to GitHub to authorize the Commitloom App
- Choose which repositories to grant access to (or select all)
- Complete installation — you'll be redirected back to Commitloom
Org installations: If you're installing to a GitHub organization, you need admin access to that org. Individual repository installs only require repository admin access.
Required permissions
| Permission | Level | Why |
|---|---|---|
pull_requests | Read + Write | Read diffs; post inline review comments; update PR descriptions |
contents | Read | Fetch the diff of changed files in a PR |
metadata | Read | Required by GitHub for all App installations |
Webhook events
Commitloom subscribes to the following GitHub webhook events:
pull_request.opened— triggers initial reviewpull_request.reopened— triggers review on reopenpull_request.synchronize— triggers re-review on push to PR branch
Uninstalling
To remove Commitloom from a repository or organization, go to your GitHub App settings (github.com/settings/installations) and revoke access. Existing reviews remain in your Commitloom dashboard but no new reviews will run.
Troubleshooting
No comments appearing on PRs: Check that the webhook delivery is succeeding in your GitHub App settings. Common causes: the PR was opened before Commitloom was installed on that repo; or the diff contains only binary files.
Re-review not triggered on push: Make sure the pull_request.synchronize event is enabled. This is on by default but can be disabled in advanced App settings.