You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/Configuration/BitBucket.md
+15-13Lines changed: 15 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ API tokens are the recommended authentication method for Bitbucket Cloud. Learn
43
43
2. Select **Create API token with scopes**.
44
44
3. Give the API token a name and an expiry date (ex: 365 days), then select **Next**.
45
45
4. Select **Bitbucket** as the app and select **Next**.
46
-
5. Select the required scopes (see **Q2**) and select **Next**.
46
+
5. Select the required scopes (see below) and select **Next**.
47
47
6. Review your token and select **Create token**.
48
48
7.**Copy the generated API token immediately** - it's only displayed once and can't be retrieved later.
49
49
@@ -63,7 +63,7 @@ The following scopes are **required** to collect data from Bitbucket repositorie
63
63
-`read:user:bitbucket` - View user info (required for connection test)
64
64
-`read:workspace:bitbucket` - View your workspaces
65
65
66
-

66
+

67
67
68
68
##### App Password (Deprecated)
69
69
@@ -73,6 +73,8 @@ App passwords are deprecated and should only be used for existing connections. F
73
73
74
74
If you're using an existing App password, learn about [how to create a Bitbucket app password](https://support.atlassian.com/bitbucket-cloud/docs/create-an-app-password/).
75
75
76
+
**Required Permissions:**
77
+
76
78
- Account:Read
77
79
- Workspace membership:Read
78
80
- Projects:Read
@@ -82,7 +84,7 @@ If you're using an existing App password, learn about [how to create a Bitbucket
@@ -117,7 +119,7 @@ Your data collection will continue without interruption, and you'll be ready for
117
119
118
120
Choose the Bitbucket repositories you wish to collect either by finding them in the miller column, or searching. You can only add public repositories through the search box.

148
150
149
151
The given settings transformed the Bitbucket issue statuses to the issue statuses used by DevLake, enabling you to measure metrics like the Issue Delivery Rate on the pre-built dashboards, as DevLake understands your definition of when an issue is considered as completed (status = 'DONE').
150
152
@@ -165,18 +167,18 @@ The CI/CD configuration for Bitbucket is used for calculating [DORA metrics](../
165
167
166
168
By default, DevLake will identify the deployment and environment settings that are defined in the Bitbucket CI .yml file.
The pipeline steps with the `deployment` key will be recognized as DevLake deployments. The value of the `deployment` key will be recognized as the environment of DevLake deployments.
174
176
175
177
All Bitbucket pipeline steps will be saved in table 'cicd_tasks', but DevLake deployments will be set as `type` = 'deployment' and `environment` = '{Bitbucket-pipeline-step.deployment.value}'.
176
178
177
179
If you have not defined these settings in the .yml file, please select 'Detect Deployments from Pipeline steps in Bitbucket', and input the RegEx in the following fields:
- Deployment: A pipeline step with a name that matches the given RegEx will be recognized as a DevLake deployment.
182
184
- Production: A pipeline step with a name that matches the given RegEx will be recognized as a DevLake cicd_task in the production environment.
@@ -186,11 +188,11 @@ If you have not defined these settings in the .yml file, please select 'Detect D
186
188
Bitbucket has several key CI entities: `pipelines`, `pipeline steps`, and `deployments`. A Bitbucket pipeline contains several pipeline steps. Each pipeline step defined with a deployment key can be mapped to a Bitbucket deployment.
187
189
188
190
Each Bitbucket pipeline is converted to a cicd_pipeline in DevLake's domain layer schema and each Bitbucket pipeline step is converted to a cicd_task in DevLake's domain layer.

194
196
195
197
###### Additional Settings (Optional)
196
198
@@ -211,14 +213,14 @@ Please click `Save` to save the transformation rules for the repo. In the data s
211
213
212
214
Collecting Bitbucket data requires creating a project first. You can visit the Project page from the side menu and create a new project by following the instructions on the user interface.
@@ -228,7 +230,7 @@ There are three settings for Sync Policy:
228
230
- Sync Frequency: You can choose how often you would like to sync your data in this step by selecting a sync frequency option or enter a cron code to specify your preferred schedule.
229
231
- Skip Failed Tasks: sometime a few tasks may fail in a long pipeline; you can choose to skip them to avoid spending more time in running the pipeline all over again.
0 commit comments