Documentation Index
Fetch the complete documentation index at: https://docs.getunblocked.com/llms.txt
Use this file to discover all available pages before exploring further.
Setting up Code Review
To set up Code Review for your Unblocked team, select Code Review from the left sidebar. Next, click Set Up Code Review. If you haven’t connected your issue tracker, you’ll be prompted to do so.
Once Code Review is enabled, you can adjust the settings to control how reviews are conducted. Click Settings in the sidebar, then select Code Review.
Select repositories
Unblocked will automatically review pull requests only for repositories you select.
Code Review user access
Use the Code Review User Access setting to control which users are eligible to receive automated code reviews.
By default, All Users is selected, so Unblocked will review pull requests for everyone in your workspace.
To limit reviews to specific people, choose Specific Users and select the users you want from the list.
Only pull requests authored by those users will receive automated code reviews.
Users who are not selected can still request a review manually by mentioning @unblocked in a PR comment. See Requesting a review for details.
Automated approval
Use this setting to control what happens when Unblocked reviews a pull request and finds no issues. The options are:
- Auto-approve (default) — automatically approve the pull request
- Comment — leave a comment saying “No issues found”
- Silent — take no action
On GitHub, auto-approvals do NOT count toward required approvals under your branch protection rules, because Unblocked isn’t a member of your organization.
Treat the AI approval as a pass signal, and keep human reviewers for final sign-off.
Custom Rules
You can customize how Unblocked reviews code by providing instructions at two levels:
- Repository instructions — When enabled, Unblocked follows repository-specific instructions from the
AGENTS.md file in the root of each repository.
- Global instructions — Add instructions that apply to every repository in your workspace by entering up to 10 KB of plain text in the Global instructions field. Use this for organization-wide standards.
Both levels work together: global instructions set the baseline, and repository instructions add more targeted guidance.
For best results, keep instructions clear, concise, and actionable.
The agents.md specification is a good reference for writing effective instructions.
Excluded paths
You can configure custom path exclusion patterns to exclude specific files or directories from review.
These patterns use glob syntax and are applied when processing pull requests.
Common exclusion patterns include *.md to exclude all Markdown files at any depth, src/test/** to exclude all files under a specific directory from the repository root, and package-lock.json to exclude specific files. You can also exclude entire directories like node_modules/** or file types like *.generated.js.
Select a bot account
This section is only required for Bitbucket Cloud, Bitbucket Data Center, GitLab Cloud, and GitLab Self-Managed repositories.
Bitbucket Cloud
Bitbucket Data Center
GitLab Cloud
GitLab Self-Managed
For Bitbucket Cloud repositories, code review comments need to be posted on behalf of a Bitbucket user account. We recommend creating an Unblocked bot account for this specific purpose.Create a bot account
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 code review comments, skip to the next step to select it.
-
Create a new account in Bitbucket with the following information:
-
Name: Unblocked
-
Avatar: download and use the Unblocked logo below
Download PNG
-
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
In Unblocked, 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 Bitbucket Cloud.
For Bitbucket Data Center repositories, code review comments need to be posted on behalf of a Bitbucket Data Center user account. We recommend creating an Unblocked bot account for this specific purpose.Create a bot account
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 code review comments, skip to the next step to select it.
-
Sign in as an administrator in your Bitbucket Data Center instance.
-
In the top navigation bar, click the admin icon.
-
Under Accounts, select Users, then Create user.
-
Create a new user account in Bitbucket Data Center with the following information:
-
Name: Unblocked
-
Avatar: download and use the Unblocked logo below
Download PNG
-
Before the bot can access a project, it must be able to sign in to Bitbucket Data Center.
- Go to Administration > Users.
- Find your bot user and ensure it is assigned to a group.
- Go to Administration > Global Permissions.
- Ensure that group has the Bitbucket User permission.
-
For each project Unblocked should review, navigate to Project settings > Permissions.
- Add the bot user and set the permission as “Developer” or above.
Select your Bot Account
In Unblocked, 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 Bitbucket Data Center.
For GitLab Cloud repositories, code review comments need to be posted on behalf of a GitLab user account. We recommend creating an Unblocked bot account for this specific purpose.Create a bot account
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 code review comments, skip to the next step to select it.
-
Create a new account in GitLab.
-
In GitLab, click on your avatar in the top right, and click Edit Profile.
-
Change the following information:
-
Name: Unblocked
-
Avatar: download and use the Unblocked logo below
Download PNG
-
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 role as “Planner” or above and click “Invite”.
Select your Bot Account
In Unblocked, 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.
For GitLab Self-Managed repositories, code review comments need to be posted on behalf of a GitLab Self-Managed user account. We recommend creating an Unblocked bot account for this specific purpose.Create a bot account
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 code review comments, skip to the next step to select it.
-
Create a new account in GitLab Self-Managed with the following information:
-
Name: Unblocked
-
Avatar: download and use the Unblocked logo below
Download PNG
-
Sign out of your GitLab Self-Managed 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 role as “Developer” or above and click “Invite”.
Select your Bot Account
In Unblocked, 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 Self-Managed.
