Unblocked for CI
Automatically analyze CI failures and get actionable fix suggestions
Unblocked for CI is currently in early access beta. Reach out if you are interested in participating.
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.
Connecting CI Systems
Today Unblocked supports Buildkite, CircleCI, and GitHub Actions. Bitbucket Pipelines and other CI systems are coming soon. Select the CI system you’d like to configure:
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 events:
build-finishedjob-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 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 events:
build-finishedjob-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 project 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 CI triage 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 CI Triage 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 CI Triage 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.