GitHub
Connect your GitHub repositories to BuildButler for CI workflow integration.
Connect your GitHub repositories to BuildButler to enable CI workflow integration, pull request status checks, and commit-level build tracking.
Generate a GitHub Personal Access Token
- Go to GitHub → Settings → Developer settings → Personal access tokens → Fine-grained tokens.
- Click Generate new token.
- Give it a descriptive name like
buildbutler. - Set the expiration as needed.
- Under Repository access, select the repositories you want to connect.
- Under Permissions, grant the following repository permissions:
- Actions — Read-only (to access workflow runs)
- Checks — Read and write (to post build status)
- Commit statuses — Read and write
- Contents — Read-only
- Pull requests — Read-only
- Click Generate token and copy it — you won't be able to see it again.
Add the connection in BuildButler
Navigate to Settings → Integrations → Add GitHub Connection and fill in the form:
Click Test Connection to verify. BuildButler will call the GitHub API and confirm it can access your repositories.
Repository selection
After connecting, BuildButler will list all accessible repositories. Select the repositories you want to monitor. BuildButler will:
- Track commits and branches associated with builds
- Link pull requests to build results
- Post build status checks on pull requests
Webhook setup (optional)
For real-time updates, you can configure a GitHub webhook:
- Go to your repository Settings → Webhooks → Add webhook.
- Set the Payload URL to your BuildButler webhook endpoint.
- Set Content type to
application/json. - Select events: Push, Pull request, Workflow run.
- Click Add webhook.
Permissions required
| Permission | Access | Purpose |
|---|---|---|
| Actions | Read-only | Access GitHub Actions workflow runs |
| Checks | Read and write | Post build status checks |
| Commit statuses | Read and write | Update commit status indicators |
| Contents | Read-only | Read repository files and commits |
| Pull requests | Read-only | Link PRs to build results |
Troubleshooting
| Symptom | Likely cause | Fix |
|---|---|---|
401 Unauthorized | Invalid or expired token | Regenerate the personal access token |
403 Forbidden | Insufficient permissions | Check token permissions match the table above |
404 Not Found | Wrong owner or repo name | Verify the organization/user and repository names |
| Rate limit errors | Too many API calls | BuildButler respects rate limits automatically — wait and retry |