Bitbucket Server Integration

SonarQube's integration with Bitbucket Server allows you to maintain code quality and security in your Bitbucket Server repositories.

With this integration, you'll be able to:

  • Import your BitBucket repositories - (starting in Developer Edition) Import your Bitbucket repositories into SonarQube to easily set up SonarQube projects.
  • Add pull request decoration - (starting in Developer Edition) See your Quality Gate and code metric results right in Bitbucket so you know if it's safe to merge your changes.

Prerequisites

  • Integration with Bitbucket Server requires at least Bitbucket Server version 5.15.

Importing your Bitbucket Server repositories into SonarQube

Setting up the import of BitBucket Server repositories into SonarQube allows you to easily create SonarQube projects from your Bitbucket Server repositories. This is also the first step in adding pull request decoration.

To set up the import of BitBucket Server repositories:

  1. Set your global settings
  2. Add a personal access token for importing repositories

Setting your global settings

To import your Bitbucket Server projects into SonarQube, you need to first set your global SonarQube settings. Navigate to Administration > Configuration > General Settings > ALM Integrations, select the Bitbucket tab, and specify the following settings:

  • Configuration Name (Enterprise and Data Center Edition only) – The name used to identify your Bitbucket Server configuration at the project level. Use something succinct and easily recognizable.
  • Bitbucket Server URL – your instances URL. For example, https://bitbucket-server.your-company.com.
  • Personal Access Token – A Bitbucket Server user account is used to decorate Pull Requests. We recommend using a dedicated Bitbucket Server account with Administrator permissions. You need a Personal Access Token from this account with Write permission for the repositories that will be analyzed. This personal access token is used for pull request decoration, and you'll be asked for another personal access token for importing projects in the following section.

Adding a personal access token for importing repositories

After setting these global settings, you can add a project from Bitbucket Server by clicking the "+" in the upper-right corner and selecting Bitbucket:

import a Bitbucket project

Then, you'll be asked to provide a personal access token from your user account with Read permissions for both projects and repositories. This token will be stored in SonarQube and can be revoked at anytime in Bitbucket Server.

After saving your Personal Access Token, you'll see a list of your Bitbucket Server projects that you can set up to add them to SonarQube. Setting up your projects this way also sets your project settings for pull request decoration.

Adding pull request decoration to Bitbucket Server

Pull request decoration shows your Quality Gate and analysis metrics directly in Bitbucket Server:

pull request decoration

To decorate Pull Requests, a SonarQube analysis needs to be run on your code. You can find the additional parameters required for Pull Request analysis on the Pull Request Analysis page.

After you've set up SonarQube to import your Bitbucket Server repositories as shown in the previous section, the simplest way to add pull request decoration is by adding a project from Bitbucket Server by clicking the "+" in the upper-right corner and selecting Bitbucket.

Then, follow the steps in SonarQube to analyze your project. The project settings for pull request decoration are set automatically.

Adding pull request decoration to a manually created or existing project

To add pull request decoration to a manually created or existing project, after you've created and installed your GitHub App and updated your global ALM Integration settings as shown above, set your project settings at Project Settings > General Settings > Pull Request Decoration.

From here, set your:

  • Configuration name – The configuration name that corresponds to your ALM instance.
  • Project Key – Part of your BitBucket Server repository URL (.../projects/{KEY}/repos/{SLUG}/browse).
  • Repo Slug – Part of your BitBucket Server repository URL (.../projects/{KEY}/repos/{SLUG}/browse).

Advanced pull request decoration configuration

Configuring multiple ALM instances

You can decorate pull requests from multiple ALM instances by creating a configuration for each ALM instance and then assigning that instance configuration to the appropriate projects.

  • As part of Developer Edition, you can create one configuration for each ALM.
  • Starting in Enterprise Edition, you can create multiple configurations for each ALM. If you have multiple configurations of the same ALM connected to SonarQube, you have to create projects manually.

Linking issues

During pull request decoration, individual issues will be linked to their SonarQube counterparts automatically. For this to work correctly, you need to set the instance's Server base URL (Administration > Configuration > General Settings > General > General) correctly. Otherwise, the links will default to localhost.