Unblocked PR Failure Agent
Automatically analyze CI failures and get actionable fix suggestions
Overview
Debugging CI (Continuous Integration) failures in pull requests can be time-consuming and complex. Unblocked streamlines this process by automatically analyzing failure logs and providing actionable fix suggestions when it has high confidence in the root cause of the failure. When a CI job fails on a pull request, Unblocked will post a report as a comment in your pull request, helping you quickly identify and resolve the issue.
Supported Systems
Today Unblocked supports the following systems:
| Bitbucket Pipelines | Buildkite | CircleCI | GitHub Actions | GitLab Pipelines | |
|---|---|---|---|---|---|
| Bitbucket | ✅ | ✅ | ✖️ | ◻️ | ◻️ |
| Bitbucket Data Center | ◻️ | ✅ | ✖️ | ◻️ | ◻️ |
| GitHub | ◻️ | ✅ | ✅ | ✅ | ◻️ |
| GitHub Enterprise | ◻️ | ✅ | ✅ | ✅ | ◻️ |
| GitLab | ◻️ | ✅ | ✅ | ◻️ | ✅ |
| GitLab Self-Hosted | ◻️ | ✅ | ✅ | ◻️ | 🚧 |
Connecting CI Systems
Select the CI system you’d like to configure:
Configuring Bitbucket Pipelines
To connect Bitbucket Pipelines to Unblocked, follow these steps:
Add CI Data Source
In the left sidebar, click on Data Sources. Then click on Add another data source and choose Continuous Integration.
Connect Bitbucket Pipelines
Click on the Bitbucket Pipelines tile.
Enable PR Failure Agent
Click Select Repositories to choose the repositories you want to enable PR Failure Agent on.
Select Repositories
Toggle the repositories you want to enable by selecting them.
Create a Bot Account
CI reports from the PR Failure Agent need to be posted on behalf of a Bitbucket user account. We recommend creating an Unblocked bot account for this specific purpose.
Already have a bot account?
Some teams already have a bot account they use for posting automated messages. If you already have a bot account that you can repurpose for posting CI analysis reports, select it and skip to the next step.
- Create a new account in Bitbucket with the following information:
- Name: Unblocked
- Avatar: download and use the Unblocked logo below
- Switch accounts and sign in to your Bitbucket Workspace as a Workspace admin.
- Click the gear icon in the top right of the navigation bar, and select User Management.
- Invite your new bot user to your workspace.
- Accept the email invitation that was sent to your bot account.
Select your Bot Account
Search for the Bot Account you just created and select it. You may be required to authorize this account with Unblocked.
Done
Click Save Settings to apply your changes. Now Unblocked will analyze CI failures in the selected repositories and post reports to pull requests.
Configuring Bitbucket Pipelines
To connect Bitbucket Pipelines to Unblocked, follow these steps:
Add CI Data Source
In the left sidebar, click on Data Sources. Then click on Add another data source and choose Continuous Integration.
Connect Bitbucket Pipelines
Click on the Bitbucket Pipelines tile.
Enable PR Failure Agent
Click Select Repositories to choose the repositories you want to enable PR Failure Agent on.
Select Repositories
Toggle the repositories you want to enable by selecting them.
Create a Bot Account
CI reports from the PR Failure Agent need to be posted on behalf of a Bitbucket user account. We recommend creating an Unblocked bot account for this specific purpose.
Already have a bot account?
Some teams already have a bot account they use for posting automated messages. If you already have a bot account that you can repurpose for posting CI analysis reports, select it and skip to the next step.
- Create a new account in Bitbucket with the following information:
- Name: Unblocked
- Avatar: download and use the Unblocked logo below
- Switch accounts and sign in to your Bitbucket Workspace as a Workspace admin.
- Click the gear icon in the top right of the navigation bar, and select User Management.
- Invite your new bot user to your workspace.
- Accept the email invitation that was sent to your bot account.
Select your Bot Account
Search for the Bot Account you just created and select it. You may be required to authorize this account with Unblocked.
Done
Click Save Settings to apply your changes. Now Unblocked will analyze CI failures in the selected repositories and post reports to pull requests.
Configuring Buildkite
To connect Buildkite to Unblocked, follow these steps:
Add CI Data Source
In the left sidebar, click on Data Sources. Then click on Add another data source and choose Continuous Integration.
Connect Buildkite
Click on the Buildkite tile.
Authorize Your Buildkite Account
-
Create a new API Access Token in Buildkite:
-
Enter “Unblocked” as the Description.
-
Choose the appropriate organization in Organization Access.
-
Select the following REST API Scopes:
read_build_logsread_buildsread_organizationsread_pipelinesread_user
-
Copy the following CIDR ranges into Allowed IP Addresses:
34.212.246.90/3244.235.109.70/3244.236.252.193/3252.88.232.82/32
-
Click Create New API Access Token.
Add a Buildkite Webhook
-
Go to the Notification Services page.
-
Click Add Webhook.
-
In the description field, enter “Unblocked”.
-
Copy and Paste the Webhook URL and Token from Unblocked into the corresponding fields in Buildkite.
-
Select the following event:
build-finished
-
Ensure that All Pipelines are selected.
-
Leave Branch filtering blank.
-
Click Add Webhook Notification.
Select Repositories
Toggle the repositories you want to enable by selecting them.
Done
Click Save Settings to apply your changes. Now Unblocked will analyze Buildkite failures in the selected repositories and post reports to pull requests.
Configuring CircleCI
To connect CircleCI to Unblocked, follow these steps:
Add CI Data Source
In the left sidebar, click on Data Sources. Then click on Add another data source and choose Continuous Integration.
Connect CircleCI
Click on the CircleCI tile.
Authorize Your CircleCI Account
-
Create a new Personal API Token in CircleCI:
-
Enter “Unblocked” as the Description.
-
Click Add API Token.
-
Paste the token into Unblocked.
Select Projects
Select the CircleCI projects you want to enable. Unblocked lists recently used projects and projects that you follow in CircleCI.
If a project is not listed, you can add it by entering the project slug, which you can find in the project settings in CircleCI.
Unblocked will automatically install an outgoing webhook in CircleCI for each project you select, so that it can receive notifications when builds fail.
Select Repositories
Toggle the repositories you want to enable by selecting them.
Done
Click Save Settings to apply your changes. Now Unblocked will analyze CircleCI failures in the selected repositories and post reports to pull requests.
Configuring GitHub Actions
To connect GitHub Actions to Unblocked, follow these steps:
Add CI Data Source
In the left sidebar, click on Data Sources. Then click on Add another data source and choose Continuous Integration.
Connect GitHub Actions
Click on the GitHub Actions tile.
Configure GitHub Actions
You may be prompted to accept additional permissions in GitHub if you haven’t already. Click Select Repositories to choose the repositories you want to enable PR Failure Agent on.
Select Repositories
Toggle the repositories you want to enable by selecting them.
Done
Click Save Settings to apply your changes. Now Unblocked will analyze GitHub Actions failures in the selected repositories and post reports to pull requests.
Configuring GitLab Pipelines
To connect GitLab Pipelines to Unblocked, follow these steps:
Add CI Data Source
In the left sidebar, click on Data Sources. Then click on Add another data source and choose Continuous Integration.
Connect GitLab Pipelines
Click on the GitLab Pipelines tile.
Enable PR Failure Agent
Click Select Repositories to choose the repositories you want to enable the PR Failure Agent on.
Select Repositories
Toggle the repositories you want to enable by selecting them.
Create a Bot Account
CI analysis reports need to be posted on behalf of a GitLab user account. We recommend creating an Unblocked bot account for this specific purpose.
Already have a bot account?
Some teams already have a bot account they use for posting automated messages. If you already have a bot account that you can repurpose for posting CI analysis reports, select it and skip to the next step.
- Create a new account in GitLab.
- Click on your avatar in the top left, and click Edit Profile.
- Change the following information:
- Name: Unblocked
- Avatar: download and use the Unblocked logo below
- Sign out of your GitLab bot account.
- Sign in as a Group admin for your GitLab Group and navigate to it.
- Click Manage in the left navigation and select Members.
- Click Invite members
- Set the maximum role as “Planner” and click “Invite”.
Select your Bot Account
Search for the Bot Account you just created and select it. You may be required to authorize this account with Unblocked.
In order to successfully authorize your bot account, you need to be logged in with that account in GitLab.
Done
Click Save Settings to apply your changes. Now Unblocked will analyze CI failures in the selected repositories and post reports to pull requests.
Configuring PR Failure Agent Reports in Personal Settings
By default, Unblocked will post reports for all developers in your organization when it has high confidence in the root cause of a CI failure. As a developer, you can control this behavior for your pull requests:
- Navigate to Settings in your Unblocked dashboard
- Select Preferences under the Personal Settings section
- Locate the PR Failure Agent toggle and set it according to your preference
This setting applies only to your pull requests, allowing you to customize your workflow while respecting team preferences.