Description

Bitbucket cloud is a source code version control repository hosting service owned by Atlassian. It contains tools to manage source code for a project. The Bitbucket cloud plug-in provides for integration with Bitbucket cloud.

Quick Info

Product
HCL Accelerate
Type
plugin
Compatibility
HCL Accelerate 2.0.0 or later
Created by
HCL Software
Updated Date
August 9, 2021
Version Name Modified date Action

1.0.7

ucv-ext-bitbucket-cloud:1.0.7.tar 26-May-2021 13:56

1.0.8

ucv-ext-bitbucket-cloud:1.0.8.tar 09-Aug-2021 06:32

ucv-ext-bitbucket-cloud:1.0.7.tar

1.0.7


ucv-ext-bitbucket-cloud:1.0.8.tar

1.0.8


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.

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

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.

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. Yes consumer_secret
Password Secure The App password used to authenticate with the Bitbucket cloud instance. 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 String The name of the repository. Yes repositoryName
Repository Slug String The slug of the repository. Yes repositorySlug
Branch Name String The branch to pull changes from. No branchName

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]" 
      } 
    }