blob: 3543b06dac919ff6ffb6530a11b72ecdb0870d98 [file] [log] [blame] [view]
---
title: "BitBucket (WIP)"
description: >
BitBucket Plugin
---
## Summary
This plugin collects various entities from Bitbucket, including pull requests, issues, comments, pipelines, git commits, and etc.
As of v0.14.2, `bitbucket` plugin can only be invoked through DevLake API. Its support in Config-UI is WIP.
## Usage via DevLake API
> Note: Please replace the `http://localhost:8080` in the sample requests with your actual DevLake API endpoint. For how to view DevLake API's swagger documentation, please refer to the "Using DevLake API" section of [Developer Setup](../DeveloperManuals/DeveloperSetup.md).
1. Create a Bitbucket data connection: `POST /plugins/bitbucket/connections`. Please see a sample request below:
```
curl --location --request POST 'http://localhost:8080/plugins/bitbucket/connections' \
--header 'Content-Type: application/json' \
--data-raw '{
"endpoint": "https://api.bitbucket.org/2.0/",
"username": "<your username>",
"password": "<your app password>",
"name": "Bitbucket Cloud"
}'
```
2. Create a blueprint to collect data from Bitbucket: `POST /blueprints`. Please see a sample request below:
```
curl --location --request POST 'http://localhost:8080/blueprints' \
--header 'Content-Type: application/json' \
--data-raw '{
"enable": true,
"mode": "NORMAL",
"name": "My Bitbucket Blueprint",
"cronConfig": "<cron string of your choice>",
"isManual": false,
"plan": [[]],
"settings": {
"connections": [
{
"plugin": "bitbucket",
"connectionId": 1,
"scope": [
{
"entities": [
"CODE",
"TICKET",
"CODEREVIEW",
"CROSS"
],
"options": {
"owner": "<owner of your repo>",
"repo": "<your repo name>"
}
}
]
}
],
"version": "1.0.0"
}
}'
```
3. [Optional] Trigger the blueprint manually: `POST /blueprints/{blueprintId}/trigger`. Run this step if you want to trigger the newly created blueprint right away. See an example request below:
```
curl --location --request POST 'http://localhost:8080/blueprints/<blueprintId>/trigger' \
--header 'Content-Type: application/json'
```