GitHub
Integrate your Airbrake project with GitHub
Description
With Airbrake’s GitHub integration, you can:
- Automatically create GitHub issue with error details for every new type of an error
- Manually create GitHub issue with error details from the Error Dashboard
- Re-open previously closed GitHub issue when a linked resolved Airbrake error re-occurs
- Collect the associated code diffs of each deploy to get insights such as additions, deletions, file changes, snapshots, and much more
GitHub Configuration
- From the GitHub integration page, click on the Redirect to GitHub for authentication button
- Log into your GitHub account and grant access to Airbrake. Make sure to grant access for all organizations where your repositories for integration are located
- Enter your full GitHub repository URL, tweak the settings, and click on the Save button
GitHub Enterprise Configuration
- Create your personal GitHub Enterprise access token
On your GitHub Enterprise account go to personal Settings:
Click on the Personal access tokens link:
Click on the Generate new token button:
Enter Token description, and select repo and public_repo scopes. Click on the Generate token button:
- From the GitHub integration page, select GitHub Enterprise from the “Integration type” select menu, and enter your personal GitHub Enterprise access token from the step 1
- Enter your full GitHub Enterprise repository URL, tweak the settings and click on the Save button
Settings
Setting | Description |
---|---|
Enabled | Pause/Unpause the integration |
Auto create GitHub issue when an error occurs | Create a GitHub issue for every new type of Airbrake error |
User for auto creation | Define the user that will be used for auto creation of new GitHub issues |
Reopen closed GitHub issue when a resolved error reoccurs | Reopen linked closed GitHub issue when a resolved error reoccurs |
Enable Code Insights | For each deploy, collect the associated code diffs to provide code insights including additions, deletions, file changes, snapshots, and much more |
Only trigger for errors with environments matching “production” (not case sensitive) | Only create GitHub issues for errors from the “production” environment |
GitHub Troubleshooting
404 error
Github integration could not connect. Error: 404 - Not Found - Please make sure the credentials are correct and try again.
If you’re seeing this 404 error despite having full access to the repo you’re trying to integrate with, please make sure third-party application access is granted for the Airbrake application.
You can find this option in your organization’s settings page: https://github.com/organizations/YOUR_ORG_NAME/settings/oauth_application_policy
To enable third-party access, please click Airbrake then click the “grant” button. If you do not see this button, go to your personal settings, in the “third-party access” section, and revoke the Airbrake token and try again.