Last updated 4 months ago

Bitbucket self-managed

Use Bitbucket Server or Bitbucket Data center as a source for your API definitions and developer portal projects.

Organization settings

Connect your Bitbucket self-managed account

Navigate to your organization settings and go to the Source control providers tab.

Organization source control providers

Scroll down to the Bitbucket self-managed section and type in the Username and Password of your Bitbucket user account into the corresponding fields. Next, provide the URL of your self-managed Bitbucket instance. The URL must start with the protocol (either http or https).

A regular user account is acceptable, but we recommend you create a service account on Bitbucket with access to desired repositories. Service accounts typically have administrative privileges, and are not used by human users, but by the system for administration and interacting with external services.

Organization source control bitbucket self-managed settings

Select Save self-managed Bitbucket settings to complete the configuration.

Connecting the source

Choose Bitbucket as source provider

Choose the Bitbucket self-managed option from the list and select "Next".

Bitbucket as source provider

Configure source details

Select a project from the list.

Select project

Repositories are grouped by project. When you select a project, the list of repositories is populated with those available to you.

Select repository

When you select a repository, the list of available branches is populated.

Select branch

Provide the path to your root API definition file, e.g. openapi.yaml.

Root file path

If you have provided the path to a .redocly.yaml file, additional options to select the root file will be available in the drop-down menu. These options are based on the apiDefinitions configuration within the selected .redocly.yaml file.

Root file path for Definitions

If your project is a Redocly Developer portal, it will be detected automatically, displaying appropriate feedback.

Developer portal detected

Build PRs as previews

Selecting the Build PR as previews checkbox will trigger a build in the selected branch when:

  • a new pull request is opened
  • an existing pull request is updated, or a new commit is pushed to any open pull request

If your API version has other usages, selecting this checkbox will trigger subsequent cascading preview builds of other APIs, reference docs, and developer portals.

Build PRs as previews