This is an automated email from the ASF dual-hosted git repository.
abeizn pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/incubator-devlake-website.git
The following commit(s) were added to refs/heads/main by this push:
new 71f4f830ed docs: bitbucket server/data-center (#691)
71f4f830ed is described below
commit 71f4f830ed92be7ce3405e589665ad32966b8279
Author: ViktorGrigorov7 <[email protected]>
AuthorDate: Fri Mar 15 06:44:06 2024 +0200
docs: bitbucket server/data-center (#691)
Co-authored-by: abeizn <[email protected]>
---
docs/Configuration/BitBucketServer.md | 71 +++++++++++++++++++
docs/Overview/SupportedDataSources.md | 15 +++-
docs/Plugins/bitbucket_server.md | 77 +++++++++++++++++++++
static/img/ConfigUI/bitbucket-server-config-ui.png | Bin 0 -> 64592 bytes
.../img/ConfigUI/bitbucket-server-permissions.png | Bin 0 -> 44824 bytes
5 files changed, 162 insertions(+), 1 deletion(-)
diff --git a/docs/Configuration/BitBucketServer.md
b/docs/Configuration/BitBucketServer.md
new file mode 100644
index 0000000000..018c53f933
--- /dev/null
+++ b/docs/Configuration/BitBucketServer.md
@@ -0,0 +1,71 @@
+---
+title: "BitBucket Data Center"
+sidebar_position: 7
+description: Config UI instruction for BitBucket(Data Center)
+---
+
+Visit Config UI at : `http://localhost:4000` and go to `Connections` page.
+
+## Step 1 - Add Data Connections
+
+
+
+### Connection Name
+
+Give your connection a unique name to help you identify it in the future.
+
+### Endpoint URL
+
+For BitBucket Data Center/Server, you do need to enter the REST API endpoint
URL, which generally is `https://<bitbucket-server>/`.
+
+DevLake will support BitBucket Server in the future.
+
+### Username and App Password
+
+The following permissions are required to collect data from BitBucket
repositories:
+
+- Repository read
+
+
+
+
+### Proxy URL (Optional)
+
+If you are behind a corporate firewall or VPN you may need to utilize a proxy
server. Enter a valid proxy server address on your network, e.g.
`http://your-proxy-server.com:1080`
+
+
+### Fixed Rate Limit (Optional)
+
+DevLake uses a dynamic rate limit to collect BitBucket data. You can adjust
the rate limit if you want to increase or lower the speed.
+
+The maximum rate limit for different entities in BitBucket(Cloud) [varies from
1,000 - 60,000
requests/hour](https://support.atlassian.com/bitbucket-cloud/docs/api-request-limits/).
The rate limit to access repository data is 1,000 requests/hour, but we find
it can still run when we input a value that exceeds 1,000. You can try using a
larger rate limit if you have large repositories.
+
+<!--

-->
+
+
+### Test and Save Connection
+
+Click `Test Connection`, if the connection is successful, click `Save
Connection` to add the connection.
+
+## Step 2 - Configure Blueprint
+
+
+
+### Repositories
+
+Select the BitBucket repositories to collect.
+
+### Data Entities
+
+Usually, you don't have to modify this part. However, if you don't want to
collect certain BitBucket entities, you can unselect some entities to
accelerate the collection speed.
+
+- Source Code Management: BitBucket repos, commits, etc.
+- Code Review: BitBucket PRs, PR comments, etc.
+
+## Step 3 - Setting Sync Policy
+
+You can choose how often you would like to sync your data in this step by
selecting a sync frequency option or entering a cron code to specify your
prefered schedule.
+
+## Troubleshooting
+
+If you run into any problems, please check the
[Troubleshooting](/Troubleshooting/Configuration.md) or [create an
issue](https://github.com/apache/incubator-devlake/issues).
diff --git a/docs/Overview/SupportedDataSources.md
b/docs/Overview/SupportedDataSources.md
index de3e7ff7d2..e34b1bb7c0 100644
--- a/docs/Overview/SupportedDataSources.md
+++ b/docs/Overview/SupportedDataSources.md
@@ -26,10 +26,11 @@ more plugins. Detailed plugin docs can be found
[here](/docs/Plugins).
| Feishu (WIP) | Calendar
| Cloud | Not Available
| `feishu` | Full Refresh
|
| AE | Source Code Management
| On-prem | Not Available
| `ae` | Full Refresh
|
| Sonarqube | CODE QUALITY
| SonarQube v8.x, v9.x | Available
| `sonarqube` | Full Refresh
|
-| Bamboo CI(WIP) | CI/CD
| v6.8.1 | Not Available
| `bamboo` | Full Refresh
|
+| Bamboo CI(WIP) | CI/CD
| v6.8.1, Server | Not Available
| `bamboo` | Full Refresh
|
| Azure Devops (Beta) | CI/CD, Source Code Management, Code Review
| Cloud | Available
| `azuredevops`, `gitextractor` | Full Refresh
|
| CircleCI | CI/CD
| Cloud | Available
| `circleci` | Full Refresh
|
+
## Data Collection Scope By Each Plugin
This table shows the entities collected by each plugin. Domain layer entities
in this table are consistent with the
@@ -175,6 +176,18 @@ the [advanced mode](../Configuration/AdvancedMode.md).
| **CollectApiPipelinesMeta** | <10^4 | ❌
| ❌ |
| CollectApiDeploymentsMeta | <10^2 | ❌
| ❌ |
+### Bitbucket Server/Data Center
+
+| Subtask Name | Estimated Max Number of Request | Does
It support Incremental Collection? | Does It Support Time Filter? |
+| ----------------------------------- | ------------------------------- |
--------------------------------------- | ---------------------------- |
+| ~~CollectApiBranchesMeta~~ | 1 | ❌
| ❌ |
+| CollectApiPullRequestsMeta | ≈10^3 | ❌
| ❌ |
+| **CollectApiPrActivitiesMeta** | ≈10^4 | ❌
| ❌ |
+| **CollectApiPrCommentsMeta** | ≈10^5 | ❌
| ❌ |
+| **\*CollectApiIssueCommentsMeta\*** | ≈10^6 | ❌
| ❌ |
+| **CollectApiCommitsMeta** | <10^4 | ❌
| ❌ |
+| CollectApiPrCommitsMeta | <10^2 | ❌
| ❌ |
+
### Gitee
| Subtask Name | Estimated Max Number of Request |
Does It support Incremental Collection? | Does It Support Time Filter? |
diff --git a/docs/Plugins/bitbucket_server.md b/docs/Plugins/bitbucket_server.md
new file mode 100644
index 0000000000..b9edfcc8ee
--- /dev/null
+++ b/docs/Plugins/bitbucket_server.md
@@ -0,0 +1,77 @@
+---
+title: "BitBucket Data Center"
+description: >
+ BitBucket Data Center Plugin
+---
+
+
+
+## Summary
+
+This plugin collects various entities from Bitbucket Data Center, including
pull requests, issues, comments, pipelines, git commits, and etc.
+
+As of v0.20.0, `bitbucket_server` plugin can only be invoked through DevLake
API. Its support in Config-UI is WIP.
+
+## Supported Versions
+
+Available for BitBucket Data Center 8.16 and BitBucket Data Center and Server
7.21. Check [this
doc](https://devlake.apache.org/docs/Overview/SupportedDataSources#data-sources-and-data-plugins)
for more details.
+
+
+## Entities
+
+Check out the [BitBucket
entities](/Overview/SupportedDataSources.md#data-collection-scope-by-each-plugin)
collected by this plugin.
+
+## Metrics
+
+Metrics that can be calculated based on the data collected from bitbucket:
+
+- [Commit Count](/Metrics/CommitCount.md)
+- [Commit Author Count](/Metrics/CommitAuthorCount.md)
+- [Added Lines of Code](/Metrics/AddedLinesOfCode.md)
+- [Deleted Lines of Code](/Metrics/DeletedLinesOfCode.md)
+- [PR Count](/Metrics/PRCount.md)
+- [PR Time To Merge](/Metrics/PRTimeToMerge.md)
+- [PR Merge Rate](/Metrics/PRMergeRate.md)
+- [PR Review Depth](/Metrics/PRReviewDepth.md)
+- [PR Size](/Metrics/PRSize.md)
+
+## Configuration
+
+- Configuring Bitbucket via [Config UI](/Configuration/BitBucketServer.md)
+
+## API Sample Request
+> 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).
+
+You can trigger data collection by making a POST request to `/pipelines`.
+```shell
+curl 'http://localhost:8080/pipelines' \
+--header 'Content-Type: application/json' \
+--data-raw '
+{
+ "name": "project1",
+ "plan": [
+ [
+ {
+ "plugin": "bitbucket",
+ "options": {
+ "connectionId": 1,
+ "fullName": "likyh/likyhphp",
+ "transformationRules":{
+ "deploymentPattern":"",
+ "productionPattern":"",
+ "issueStatusTodo":"new,open",
+ "issueStatusInProgress":"",
+ "issueStatusDone":"resolved,closed",
+ "issueStatusOther":"on hold,wontfix,duplicate,invalid"
+ }
+ }
+ }
+ ]
+ ]
+}
+'
+```
+
+## References
+
+- [references](/DeveloperManuals/DeveloperSetup.md#references)
diff --git a/static/img/ConfigUI/bitbucket-server-config-ui.png
b/static/img/ConfigUI/bitbucket-server-config-ui.png
new file mode 100644
index 0000000000..de33237a48
Binary files /dev/null and b/static/img/ConfigUI/bitbucket-server-config-ui.png
differ
diff --git a/static/img/ConfigUI/bitbucket-server-permissions.png
b/static/img/ConfigUI/bitbucket-server-permissions.png
new file mode 100644
index 0000000000..a30a2c5a03
Binary files /dev/null and
b/static/img/ConfigUI/bitbucket-server-permissions.png differ