BuildButler

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

  1. Go to GitHub → Settings → Developer settings → Personal access tokens → Fine-grained tokens.
  2. Click Generate new token.
  3. Give it a descriptive name like buildbutler.
  4. Set the expiration as needed.
  5. Under Repository access, select the repositories you want to connect.
  6. 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
  7. 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:

{
  "name": "My GitHub Org",
  "owner": "my-org",
  "token": "github_pat_..."
}

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:

  1. Go to your repository Settings → Webhooks → Add webhook.
  2. Set the Payload URL to your BuildButler webhook endpoint.
  3. Set Content type to application/json.
  4. Select events: Push, Pull request, Workflow run.
  5. Click Add webhook.

Permissions required

PermissionAccessPurpose
ActionsRead-onlyAccess GitHub Actions workflow runs
ChecksRead and writePost build status checks
Commit statusesRead and writeUpdate commit status indicators
ContentsRead-onlyRead repository files and commits
Pull requestsRead-onlyLink PRs to build results

Troubleshooting

SymptomLikely causeFix
401 UnauthorizedInvalid or expired tokenRegenerate the personal access token
403 ForbiddenInsufficient permissionsCheck token permissions match the table above
404 Not FoundWrong owner or repo nameVerify the organization/user and repository names
Rate limit errorsToo many API callsBuildButler respects rate limits automatically — wait and retry

On this page