Platform.sh User Documentation

Integrate with Bitbucket

Back to home

On this page

Try for 30 days
Flexible, version-controlled infrastructure provisioning and development-to-production workflows
Activate your trial

If you have code in a Bitbucket repository, you might want to connect it to a Platform.sh project. This means you can keep your Bitbucket workflows and treat the Bitbucket repository as the source of truth for your code.

Your Platform.sh project becomes a mirror of your Bitbucket repository. This means you shouldn’t push code directly to Platform.sh. Any changes you push directly get overwritten by the integration when changes happen in the Bitbucket repository.

When you set up an integration with Bitbucket, it automates the following processes for you:

  • Creating a new environment when a branch is created or a pull request is opened.
  • Rebuilding the environment when new code is pushed to Bitbucket.
  • Deleting the environment when a pull request is merged.

You can set up an integration with either Bitbucket Cloud or a self-hosted Bitbucket Server.

Before you begin Anchor to this heading

To manage source integrations, you need to be a project admin.

You also need a Bitbucket Cloud or Bitbucket Server repository with working code.

Bitbucket Cloud Anchor to this heading

1. Create an OAuth consumer Anchor to this heading

To integrate your Platform.sh project with an existing Bitbucket Cloud repository, create an OAuth consumer:

A screenshot of how to setup the Bitbucket OAuth consumer

The Callback URL isn’t important in this case. You can set it to http://localhost.

Copy the Key and Secret for your consumer.

2. Enable the Cloud integration Anchor to this heading

To enable the integration, use either the CLI or the Console.

Run the following command:

platform integration:add \
  --project PROJECT_ID \
  --type bitbucket \
  --repository OWNER/REPOSITORY \
  --key CONSUMER_KEY \
  --secret CONSUMER_SECRET

For example, if your repository is located at https://bitbucket.org/platformsh/platformsh-docs, the command is similar to the following:

platform integration:add \
  --project abcdefgh1234567 \
  --type bitbucket \
  --repository platformsh/platformsh-docs \
  --key abc123 \
  --secret abcd1234 \
  1. Select the project where you want to enable the integration.
  2. Click Settings.
  3. Under Project settings, click Integrations.
  4. Click + Add integration.
  5. Under Bitbucket, click + Add.
  6. Complete the form with:
  7. Check that the other options match what you want.
  8. Click Add integration.

In both the CLI and Console, you can choose from the following options:

CLI flag Default Description
fetch-branches true Whether to mirror and update branches on Platform.sh and create inactive environments from them. When enabled, merging on a Platform.sh isn’t possible. That is, merging environments must be done on the source repository rather than on the Platform.sh project. See note below for details related to this flag and synchronizing code from a parent environment.
prune-branches true Whether to delete branches from Platform.sh that don’t exist in the Bitbucket repository. When enabled, branching (creating environments) must be done on the source repository rather than on the Platform.sh project. Branches created on Platform.sh that are not on the source repository will not persist and will be quickly pruned. Automatically disabled when fetching branches is disabled.
build-pull-requests true Whether to track all pull requests and create active environments from them, which builds the pull request.
resync-pull-requests false Whether to sync data from the parent environment on every push to a pull request.

To keep your repository clean and avoid performance issues, make sure you enable both the fetch-branches and prune-branches options.

3. Validate the integration Anchor to this heading

Verify that your integration is functioning properly using the CLI:

platform integration:validate

Add the webhook manually Anchor to this heading

If the integration was added with the correct permissions, the necessary webhook is added automatically. If you see a message that the webhook wasn’t added, add one manually.

To configure a webhook on a Bitbucket repository, you need to have Admin user permissions.

  1. Get the webhook URL by running this command: platform integration:get --property hook_url.

  2. Copy the returned URL.

  3. Follow the Bitbucket instructions to create a webhook using the URL you copied. Make sure to update the triggers to include all pull request events except comments and approval.

You can now start pushing code, creating new branches, and opening pull requests directly in your Bitbucket repository. Your Platform.sh environments are automatically created and updated.

Bitbucket Server Anchor to this heading

1. Generate a token Anchor to this heading

To integrate your Platform.sh project with a repository on a Bitbucket Server instance, you first need to create an access token associated with your account.

Generate a token. and give it at least read access to projects and admin access to repositories. Copy the token.

2. Enable the Server integration Anchor to this heading

To enable the integration, use either the CLI or the Console.

Run the following command:

platform integration:add \
  --project PROJECT_ID \
  --type bitbucket_server \
  --repository OWNER/REPOSITORY \
  --username BITBUCKET_USERNAME \
  --token BITBUCKET_SERVER_ACCESS_TOKEN \
  --bitbucket-url BITBUCKET_SERVER_URL
  • PROJECT_ID is the ID of your Platform.sh project.
  • OWNER/REPOSITORY is the name of the repository in Bitbucket server.
  • BITBUCKET_SERVER_ACCESS_TOKEN is the token you generated.
  • BITBUCKET_SERVER_URL is the URL for your Bitbucket server.

For example, if your repository is located at https://example.com/platformsh/platformsh-docs, the command is similar to the following:

platform integration:add \
  --project abcdefgh1234567 \
  --type bitbucket_server \
  --repository platformsh/platformsh-docs \
  --username user@example.com \
  --token abc123
  --bitbucket-url https://example.com

  1. Select the project where you want to enable the integration.

  2. Click Settings.

  3. Under Project settings, click Integrations.

  4. Click + Add integration.

  5. Under Bitbucket server, click + Add.

  6. Complete the form with:

    • Your server URL
    • Your Bitbucket username
    • The token you generated
    • The Bitbucket server project name
    • The repository in the form owner/repository

  7. Check that the other options match what you want.

  8. Click Add integration.

In both the CLI and Console, you can choose from the following options:

CLI flag Default Description
fetch-branches true Whether to mirror and update branches on Platform.sh and create inactive environments from them.
prune-branches true Whether to delete branches from Platform.sh that don’t exist in the Bitbucket server repository. Automatically disabled when fetching branches is disabled.
build-pull-requests true Whether to track all pull requests and create active environments from them, which builds the pull request.
pull-requests-clone-parent-data true Whether to clone data from the parent environment when creating a pull request environment.

To keep your repository clean and avoid performance issues, make sure you enable both the fetch-branches and prune-branches options.

3. Validate the integration Anchor to this heading

Verify that your integration is functioning properly using the CLI:

platform integration:validate

Add the webhook manually Anchor to this heading

If the integration was added with the correct permissions, the necessary webhook is added automatically. If you see a message that the webhook wasn’t added, add one manually.

To configure a webhook on a Bitbucket repository, you need to have Admin user permissions.

  1. Get the webhook URL by running this command: platform integration:get --property hook_url.

  2. Copy the returned URL.

  3. Follow the Bitbucket instructions to create a webhook using the URL you copied. Send all events except comments and approval.

You can now start pushing code, creating new branches, and opening pull requests directly in your Bitbucket repository. Your Platform.sh environments are automatically created and updated.

Environment parent and status Anchor to this heading

When a branch is created in Bitbucket, an environment is created in Platform.sh with the default branch as its parent. It starts as an inactive environment with no data or services.

When a pull request is opened in Bitbucket, an environment is created in Platform.sh with the pull request’s target branch as its parent. It starts as an active environment with a copy of its parent’s data.

Source of truth Anchor to this heading

When you add an integration, your Bitbucket repository is considered to be the source of truth for the project. Your Platform.sh project is only a mirror of that repository and you can only push commits to Bitbucket.

To clone your code, follow these steps:

Run the following command:

platform get PROJECT_ID
  1. In the Console, open the project you want to clone.
  2. Click Code.
  3. Click Git.
  4. Run the command you find using Git.

When you do this, you're cloning from your integrated Bitbucket repository, if you have the appropriate access to do so.

Sync, fetch, and prune Anchor to this heading

An integration from Bitbucket to Platform.sh establishes that:

  • Bitbucket is the source of truth, where Git operations occur
  • Platform.sh is a mirror of that repository - provisioning infrastructure according to configuration, and orchestrating environments according to the branch structure of the Bitbucket repository

Actions that take place on Platform.sh don’t affect commits on Bitbucket. Because of this, the Bitbucket integration enables both fetch-branches (track branches on Bitbucket) and prune-branches (delete branches that don’t exist on Bitbucket) by default. You can change these settings but it is recommend to keep them.

When enabled by default, you are limited by design as to what actions can be performed within the context of a Platform.sh project with a Bitbucket integration:

Action Observation Recommendation
Branch from parent Running environment:branch with the CLI, or selecting Branch in Console produces a new child environment, but it’s deleted shortly after automatically. Contribute to the Bitbucket repository itself by creating a branch and pull request. When the PR has been opened, a new environment will be provisioned for it.
Merge in parent Running environment:merge with the CLI fails locally, and the Merge option in Console is not clickable. Review and merge pull requests and/or branches on the Bitbucket repository.
Merge into child (sync code) Running environment:synchronize with the CLI fails locally, and the Sync option in Console won’t allow me to include code in that sync. Perform the merge locally from a matching branch on Bitbucket. For example, clone the most recent parent (git pull origin parent-branch), switch to the pull request branch (git checkout ga-staging), and then merge the parent into the current branch (git merge main).

Pull request URLs Anchor to this heading

When a pull request is deployed, the integration reports the primary URL for the deployed environment. So you get a link to the deployed environment right in the pull request.

If you have multiple routes, ensure the correct one is reported by specifying the primary route.