Bitbucket integration

You can configure your Bitbucket repository to automatically build and deploy an environment when you push code changes. This integration synchronizes your Bitbucket repository with your Magento Commerce Cloud account.

For Pro projects created before October 23, 2017, this integration works on Integration environments only. You must request an upgrade before you can use this integration on Staging and Production environments.

We strongly recommend using a private repository for your Magento Commerce Cloud project to protect any proprietary information or development work, such as extensions and sensitive configurations.

Before you enable the integration, you must have the following:

  • Administrator access to the Magento Commerce Cloud project
  • magento-cloud CLI tool in your local environment
  • A Bitbucket account
  • Administrator access to the Bitbucket repository
  • An SSH access key for the Bitbucket repository

Prepare your repository

You need to clone your Magento Commerce Cloud project from an existing environment and migrate the project branches to a new, empty Bitbucket repository, preserving the same branch names. It is critical to retain an identical Git tree, so that you do not lose any existing environments or branches in your Magento Commerce Cloud project.

  1. From the terminal, log in to your Magento Commerce Cloud project.

    magento-cloud login
    
  2. List your projects and copy the project ID.

    magento-cloud project:list
    
  3. Clone the project to your local environment.

    magento-cloud project:get <project-ID>
    
  4. Add your Bitbucket repository as a remote.

    git remote add origin git@bitbucket.org:<user-name>/<repo-name>.git
    
  5. Delete the default magento remote.

    git remote remove magento
    
  6. Verify that you added the Bitbucket remote correctly.

    git remote -v
    

    You should see the following:

    origin git@bitbucket.org:<user-name>/<repo-name>.git (fetch)
    origin git@bitbucket.org:<user-name>/<repo-name>.git (push)
    
  7. Push the project files to your new Bitbucket repository. Remember to keep all branch names the same.

    git push -u origin master
    

    If you are starting with a new Bitbucket repository, you may have to use the -f option, because the remote repository does not match your local copy.

  8. Verify that your Bitbucket repository contains all of your project files.

Create an OAuth consumer

The Bitbucket integration requires an OAuth consumer. You need the OAuth key and secret from this consumer to complete the next section.

To create an OAuth consumer in Bitbucket:

  1. Log in to your Bitbucket account.

  2. Click Settings > Access Management > OAuth.

  3. Click Add consumer and configure it as follows:

    Bitbucket OAuth consumer configuration

    A valid Callback URL is not required, but you must enter a value in this field to successfully complete the integration.

  4. Click Save.

  5. Click the consumer Name to reveal your OAuth key and secret.

  6. Copy your OAuth key and secret for configuring the integration.

Configure the integration

  1. From the terminal, navigate to your Magento Commerce Cloud project.

  2. Create a temporary file called bitbucket.json and add the following, replacing the variables in angle brackets with your values:

    {
      "type": "bitbucket",
      "repository": "<bitbucket-user-name/bitbucket-repo-name>",
      "app_credentials": {
        "key": "<oauth-consumer-key>",
        "secret": "<oauth-consumer-secret>"
      },
      "prune_branches": true,
      "fetch_branches": true,
      "build_pull_requests": true,
      "resync_pull_requests": true
    }
    

    Be sure to use the name of your Bitbucket repository and not the URL. The integration fails if you use a URL.

  3. Add the integration to your project using the magento-cloud CLI tool.

    The following command overwrites all code in your Magento Commerce Cloud project with code from your Bitbucket repository. This includes all branches, including the Production branch. This action happens instantly and cannot be undone. As a best practice, it is very important to clone all of your branches from your Magento Commerce Cloud project and push them to your Bitbucket repository before adding the Bitbucket integration.

    magento-cloud project:curl -p '<project-ID>' /integrations -i -X POST -d "$(< bitbucket.json)"
    

    This returns a long HTTP response with headers. A successful integration returns a 200 or 201 status code. A status of 400 or above indicates that an error occurred.

  4. Delete the temporary bitbucket.json file.

  5. Verify the project integration.

    magento-cloud integrations -p '<project-ID>'
    
    +----------+-----------+--------------------------------------------------------------------------------+
    | ID       | Type      | Summary                                                                        |
    +----------+-----------+--------------------------------------------------------------------------------+
    | <int-id> | bitbucket | Repository: bitbucket_Account/magento-int.git                                  |
    |          |           | Hook URL:                                                                      |
    |          |           | https://magento-url.cloud/api/projects/<project-id>/integrations/<int-id>/hook |
    +----------+-----------+--------------------------------------------------------------------------------+
    

    Make a note of the Hook URL to configure a webhook in BitBucket.

Add a webhook in BitBucket

In order to communicate events—such as a push—with your Cloud Git server, you need to create a webhook for your BitBucket repository.

  1. Log in to your Bitbucket account.

  2. Click Repositories and select your project.

  3. Click Settings > Workflow > Webhooks.

  4. Click Add webhook.

  5. In the Add new webhook view, edit the following fields:

    • Title: Magento Cloud Integration
    • URL: Use the Hook URL from your magento-cloud integration list
    • Triggers: The default is a basic Repository push
  6. Click Save.

Test the integration

After configuring the Bitbucket integration, test it by pushing a simple change to your Bitbucket repository.

  1. Create a test file.

    touch test.md
    
  2. Commit and push the change to your Bitbucket repository.

    git add . && git commit -m "Testing Bitbucket integration" && git push
    
  3. Log in to the Project Web Interface and verify that your commit message is displayed and your project deploying.

    Testing the Bitbucket integration

Create a new Cloud branch

The Bitbucket integration cannot activate new environments in your Magento Commerce Cloud project. If you create an environment with Bitbucket, you must activate the environment manually. To avoid this extra step, it is best practice to create environments using the magento-cloud CLI tool or the Project Web UI.

To activate a branch created with Bitbucket:

  1. Use the magento-cloud CLI to push the branch.

    magento-cloud environment:push from-bitbucket
    
    Pushing from-bitbucket to the new environment from-bitbucket
    Activate from-bitbucket after pushing? [Y/n] y
    Parent environment [master]: integration
    --- (Validation and activation messages)
    
  2. Verify the environment is active.

    magento-cloud environment:list
    
    Your environments are: 
    +---------------------+----------------+--------+
    | ID                  | Name           | Status |
    +---------------------+----------------+--------+
    | master              | Master         | Active |
    |  integration        | integration    | Active |
    |    from-bitbucket * | from-bitbucket | Active |
    +---------------------+----------------+--------+
    * - Indicates the current environment
    

After you create a new environment, you can push the corresponding branch to your remote Bitbucket repository using regular Git commands. Subsequent changes to your branch in Bitbucket automatically build and deploy the environment.

Remove the integration

You can safely remove the Bitbucket integration from your project without affecting your code.

To remove the Bitbucket integration:

  1. From the terminal, log in to your Magento Commerce Cloud project.

  2. List your integrations. You need the Bitbucket integration ID to complete the next step.

    magento-cloud integration:list
    
  3. Delete the integration.

    magento-cloud integration:delete <project-ID>
    

Also, you can remove the Bitbucket integration by logging in to your Bitbucket account and revoking the OAuth grant on the account Settings page.