Bitbucket Enterprise

Bitbucket is a web-based version control repository hosting service, for source code and development projects that use either Mercurial or Git revision control systems.

This topic describes the steps for integrating SEI with Bitbucket Enterprise using the SEI Bitbucket Enterprise integration.

Requirements

The following permissions and settings are required to use the SEI Bitbucket integration:

  • You have a Bitbucket account.

  • Your role is Member or higher.

Configure the private on-prem integration

  1. Select Integrations under Settings.

  2. Select Available Integrations, and locate the Bitbucket Enterprise integration, and select Install

  3. Select Install.

  4. Configure and save the integration.

    • Provide a name for the integration.

    • The Description and Tags are optional.

    • Enter the URL for the Bitbucket private instance in the format https://bitbucket.org/<teamName_or_username>/<repo-name>/src

    • Enter your username

    • Enter the Bitbucket API Key. To generate an API key for your Bitbucket instance, go to Managing API tokens for Bitbucket.

    • Enter tags and the list of repositories you want to ingest. You can leave this option blank if you want to ingest all the repositories from organizations accessible to the token user.

    • You can select the filters to define the type of data you want to ingest. The available options are Fetch Commits, Fetch PRs, Fetch PRs Reviews, Fetch Commits Fields.

    • Download the satellite.yml file and update it following the instructions here.

If you encounter any issues during the integration process, go to the Satellite integration Troubleshooting and FAQs.

Here’s a sample satellite.yaml file generated for the Bitbucket enterprise integration:

satellite:
  tenant: foo
  api_key: <SEI_API_KEY>
  url: 'https://staging.api.propelo.ai'
integrations:
  - id: '<INTEGRATION_ID>'
    application: bitbucket_server
    url: 'https://bitbucket.org/<teamName_or_username>/<repo_name>/src'
    username: <BITBUCKET_USERNAME>
    api_key: <BITBUCKET_API_KEY>
    metadata:
      fetch_prs: true
      fetch_pr_reviews: true
      fetch_commits: true
      fetch_commit_files: true
      repos: docs-repo
    satellite: true

Configure the public on-prem integration

The steps for configuring the public on-premises integration for Bitbucket are similar to the private on-premises integration, with the exception of using satellite to communicate with the Bitbucket server. Instead, the public on-premises integration directly uses the credentials provided by the user to authenticate with the Bitbucket server.

Last updated