You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@devlake.apache.org by "mindlesscloud (via GitHub)" <gi...@apache.org> on 2023/01/27 11:49:10 UTC
[GitHub] [incubator-devlake-website] mindlesscloud opened a new pull request, #410: Update bitbucket docs
mindlesscloud opened a new pull request, #410:
URL: https://github.com/apache/incubator-devlake-website/pull/410
# Summary
updated the bitbucket docs
- docs/Plugins/bitbucket.md
- docs/UserManuals/ConfigUI/AdvancedMode.md
- versioned_docs/version-v0.15/Plugins/bitbucket.md
- versioned_docs/version-v0.15/UserManuals/ConfigUI/AdvancedMode.md
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-devlake-website] Startrekzky commented on a diff in pull request #410: Update bitbucket docs
Posted by "Startrekzky (via GitHub)" <gi...@apache.org>.
Startrekzky commented on code in PR #410:
URL: https://github.com/apache/incubator-devlake-website/pull/410#discussion_r1090406557
##########
docs/Plugins/bitbucket.md:
##########
@@ -12,66 +12,58 @@ This plugin collects various entities from Bitbucket, including pull requests, i
As of v0.14.2, `bitbucket` plugin can only be invoked through DevLake API. Its support in Config-UI is WIP.
+## Entities
-## Usage via DevLake API
+Check out the [Bitbucket entities](/Overview/SupportedDataSources.md#data-collection-scope-by-each-plugin) collected by this plugin.
Review Comment:
Please Use BitBucket, not Bitbucket or bitbucket.
##########
docs/Plugins/bitbucket.md:
##########
@@ -12,66 +12,58 @@ This plugin collects various entities from Bitbucket, including pull requests, i
As of v0.14.2, `bitbucket` plugin can only be invoked through DevLake API. Its support in Config-UI is WIP.
+## Entities
-## Usage via DevLake API
+Check out the [Bitbucket entities](/Overview/SupportedDataSources.md#data-collection-scope-by-each-plugin) collected by this plugin.
-> 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).
+## Metrics
+Metrics that can be calculated based on the data collected from bitbucket:
-1. Create a Bitbucket data connection: `POST /plugins/bitbucket/connections`. Please see a sample request below:
+- [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)
+- [Build Count](/Metrics/BuildCount.md)
+- [Build Duration](/Metrics/BuildDuration.md)
+- [Build Success Rate](/Metrics/BuildSuccessRate.md)
-```
-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"
-}'
-```
+## Configuration
-2. Create a blueprint to collect data from Bitbucket: `POST /blueprints`. Please see a sample request below:
+- Configuring Bitbucket via [Config UI](/UserManuals/ConfigUI/BitBucket.md)
+- Configuring Bitbucket via Config UI's [advanced mode](/UserManuals/ConfigUI/AdvancedMode.md).
Review Comment:
use the anchor link to the BitBucket example?
##########
docs/UserManuals/ConfigUI/AdvancedMode.md:
##########
@@ -303,6 +303,28 @@ You must choose at least one of `productId`, `projectId` and `executionId`.
2. Then the number in the red square above is `ExecutionId`
+### 9. Bitbucket
Review Comment:
BitBucket
##########
docs/UserManuals/ConfigUI/AdvancedMode.md:
##########
@@ -303,6 +303,28 @@ You must choose at least one of `productId`, `projectId` and `executionId`.
2. Then the number in the red square above is `ExecutionId`
+### 9. Bitbucket
+Below is an example for collecting a bitbucket repo.
+
+```json
+[
+ [
+ {
+ "plugin": "bitbucket",
+ "options": {
+ "connectionId": 1,
+ "owner": "merico",
Review Comment:
Use apache?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [incubator-devlake-website] Startrekzky merged pull request #410: Update bitbucket docs
Posted by "Startrekzky (via GitHub)" <gi...@apache.org>.
Startrekzky merged PR #410:
URL: https://github.com/apache/incubator-devlake-website/pull/410
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@devlake.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org