• Overview
  • Documentation
  • Version history

Description

BitBucket Cloud is a source code version control repository hosting service owned by Atlassian. You can use the available tools to manage source code for a project with an exclusive built-in CI/CD tool and Pipelines that enables you to build, test, and deploy your applications directly within the BitBucket Cloud.

Quick Info

Product icon

Product

DevOps Velocity (HCL Accelerate)
Plugin type icon

Type

plugin
Compatibility icon

Compatibility

HCL Accelerate 2.0.0 or later
created by icon

Created by

HCL Software
Website icon

Website

Published Date

Last Updated

Summary

The Bitbucket Cloud plugin provides for integration with a Bitbucket Cloud.

Compatibility

This plugin requires HCL Accelerate 2.0.0 or later.

History

The following table describes the changes made in each plugin version.

1.0.8Auto-generated User Access Key support added. Applies to HCL Accelerate version 2.4.0 and later.1.0.7Minor updates

Plugin history details
Version Description
1.0.16 Repo Slug and Project Name fields are removed, Multiple repositories support in Repository Name is now possible”, Additional branches field is added]r.

Usage

To use the Bitbucket Cloud plugin, the plugin must be loaded and an instance created before you can configure the plugin integration. You define configuration properties in the user interface or in a JSON file.

Integration type

The Bitbucket Cloud plugin supports scheduled events integration which is listed in the following table.

Scheduled events
Name Description
syncBitbucketPullRequestsEvent Queries the Bitbucket Cloud for pull requests in a project.
syncBitbucketCommitsEvent Queries the Bitbucket Cloud for commits in a project.

Integration

There are two methods to integrate the plugin:

  • Using the user interface
  • Using a JSON file

Using the user interface

  1. From the Plugins page, click Settings > Integrations > Plugins.
  2. Under the Action column for the plugin, click Add Integration.
  3. On the Add Integration page enter values for the fields used to configure the integration and define communication.
  4. Click Save.

Using a JSON file

The JSON file contains the information for creating a value stream and integrating with the Bitbucket Cloud. The following table describes the information for the creating a HCL Accelerate value stream map.

  1. From a value stream page, download the value stream map. The value stream map is a JSON file used to define integrations.
  2. Edit the JSON file to include the plugin configuration properties.
  3. Save and upload the JSON file. This replaces the current JSON file with the new content.
  4. View the new integration on the Integrations page.

Configuration Properties

The following tables describe the properties used to configure the integration. Each table contains the field name when using the user interface and the property name when using a JSON file.

  • The General Configuration Properties table describes configuration properties used by all plugin integrations.
  • The Bitbucket Cloud Configuration Properties table describes the Bitbucket configuration properties that define the connection and communications with the Bitbucket Cloud. When using the JSON method to integrate the plugin these properties are coded within the properties configuration property.

Not all configuration properties are initially displayed in the user interface, to see all properties enable the Hidden field.

NOTE: Previously Email-ID and password (Those which are used to log into the bitbucket-cloud website) were used in the field of Username and password respectively. Now from version 1.0.16 Username(https://bitbucket.org/account/settings/) and App-password(https://bitbucket.org/account/settings/app-passwords/) will be used in the field of Username and password authenticate with the bitbucket cloud in

General Configuration properties
Name Description Required Property Name
Integration Name An assigned name to the value stream. Yes name
Logging Level The level of Log4j messages to display in the log file. Valid values are: all, debug, info, warn, error, fatal, off, and trace. No loggingLevel
properties List of plugin configuration properties used to connect and communicate with the Bitbucket Cloud. Enclose the properties within braces. Yes properties
Tenant id The name of the tenant. Yes tenant_id
Type Unique identifier assigned to the plugin. The value for the Bitbucket Cloud plugin is ucv-ext-bitbucket-cloud Yes type
Bitbucket Cloud Properties
Name Type Description Required Property Name
User Access Key Secure The access token secret for oauth authentication. Yes ucvAccessKey
Base Api Url String The URL to the API. Yes baseApiUrl
Username String The user name used to authenticate with the Bitbucket cloud instance.You can find it here https://bitbucket.org/account/settings/ Yes consumer_secret
Password Secure The App password used to authenticate with the Bitbucket cloud instance.You can create one here https://bitbucket.org/account/settings/app-passwords/ Yes password
Project Key String The repository project key. Yes projectKey
Project Name String The name of the project which contains one or more repositories. Yes projectName
Repository Name Array The comma separated name of the repositories Yes repositoryName
Repository Slug String The slug of the repository. Yes repositorySlug
Branch Name String The branch to pull changes from. No branchName
Additional Branches Array Comma seperated names of additional branches to collect commits from besides the main one, leave blank if not needed. No otherBranches

JSON code sample

The following sample code can be used as a template to define the integration within the JSON file for a value stream. Copy and paste the template into the JSON file Integration section and make the appropriate changes.


{ 
     "type": "ucv-ext-bitbucket-cloud", 
      "tenant_id": "5ade13625558f2c6688d15ce", 
      "name": "my-bitbucket", 
      "loggingLevel": "info",
      "disabled": false, 
      "properties": { 
        "baseApiUrl": "[Base URL ex: https://bitbucket.org/api/2.0]", 
        "username": "[Basic User Name]", 
        "password": "[Basic user password]", 
        "projectName": "[Full project name ex: JKE Mortgage Application]", 
        "projectKey": "[Project key ex: JMA]", 
        "repositoryName": "[app repository name ex: web-application]", 
        "repositorySlug": "[app repository name ex: web-application]" 
      } 
    }

ucv-ext-bitbucket-cloud:1.0.29.tar

Uploaded: 27-Dec-2022 12:00

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-bitbucket-cloud:1.0.29
 

Release Notes

  • Initial Sync Date Field Added: Under the hidden properties section of add integration page for the plugin an Initial Sync Date field is added. This field is optional and can be used only for the first sync.

ucv-ext-bitbucket-cloud:1.0.22.tar

Uploaded: 07-Jun-2022 03:59

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-bitbucket-cloud:1.0.22
 

Release Notes

  • reduced vulnerability

ucv-ext-bitbucket-cloud:1.0.16.tar

Uploaded: 25-Mar-2022 13:38

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-bitbucket-cloud:1.0.16
 

Release Notes

  • Removed repoSlug and projectName field
  • added multiple repositories support in repoName
  • added otherBranches field

ucv-ext-bitbucket-cloud:1.0.15.tar

Uploaded: 23-Feb-2022 07:14

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-bitbucket-cloud:1.0.15
 

Release Notes

  • UAK Related Changes

ucv-ext-bitbucket-cloud:1.0.8.tar

Uploaded: 09-Aug-2021 06:32

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-bitbucket-cloud:1.0.8
 

Release Notes

  • Auto-generated UAK update

ucv-ext-bitbucket-cloud:1.0.7.tar

Uploaded: 26-May-2021 13:56

Pull Command

docker pull hclcr.io/accelerate/ucv-ext-bitbucket-cloud:1.0.7
 

Release Notes

  • Initial Release

Related Plugins