This is an automated email from the ASF dual-hosted git repository.
klesh 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 7c31eb20fde docs(bitbucket): copy all documentation images locally
(#809)
7c31eb20fde is described below
commit 7c31eb20fde68a52987c86a498971cd38ac33018
Author: Sanjeev Penupala <[email protected]>
AuthorDate: Fri Oct 10 05:06:29 2025 -0500
docs(bitbucket): copy all documentation images locally (#809)
---
docs/Configuration/BitBucket.md | 28 +++++++++++----------
static/img/ConfigUI/bitbucket-add-data-scopes.png | Bin 0 -> 54668 bytes
.../ConfigUI/bitbucket-ci-entities-overview.png | Bin 0 -> 236837 bytes
.../bitbucket-deployment-pipeline-history.png | Bin 0 -> 318878 bytes
.../ConfigUI/bitbucket-detect-deployments-dora.png | Bin 0 -> 24306 bytes
.../bitbucket-detect-deployments-regex.png | Bin 0 -> 36612 bytes
.../ConfigUI/bitbucket-issue-status-mapping.png | Bin 0 -> 16757 bytes
.../bitbucket-pipelines-deployment-settings.png | Bin 0 -> 260303 bytes
8 files changed, 15 insertions(+), 13 deletions(-)
diff --git a/docs/Configuration/BitBucket.md b/docs/Configuration/BitBucket.md
index 74f9acfea54..896f60e21e7 100644
--- a/docs/Configuration/BitBucket.md
+++ b/docs/Configuration/BitBucket.md
@@ -43,7 +43,7 @@ API tokens are the recommended authentication method for
Bitbucket Cloud. Learn
2. Select **Create API token with scopes**.
3. Give the API token a name and an expiry date (ex: 365 days), then select
**Next**.
4. Select **Bitbucket** as the app and select **Next**.
-5. Select the required scopes (see **Q2**) and select **Next**.
+5. Select the required scopes (see below) and select **Next**.
6. Review your token and select **Create token**.
7. **Copy the generated API token immediately** - it's only displayed once and
can't be retrieved later.
@@ -63,7 +63,7 @@ The following scopes are **required** to collect data from
Bitbucket repositorie
- `read:user:bitbucket` - View user info (required for connection test)
- `read:workspace:bitbucket` - View your workspaces
-
+
##### App Password (Deprecated)
@@ -73,6 +73,8 @@ App passwords are deprecated and should only be used for
existing connections. F
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/).
+**Required Permissions:**
+
- Account:Read
- Workspace membership:Read
- Projects:Read
@@ -82,7 +84,7 @@ If you're using an existing App password, learn about [how to
create a Bitbucket
- Pipelines:Read
- Runners:Read
-
+
#### Proxy URL (Optional)
@@ -117,7 +119,7 @@ Your data collection will continue without interruption,
and you'll be ready for
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.
-
+
### Step 1.3 - Add Scope Config (Optional)
@@ -144,7 +146,7 @@ The transformations on the Bitbucket data you are going to
collect.
###### Issue Tracking > Issue Status Mapping
-
+
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').
@@ -165,10 +167,10 @@ The CI/CD configuration for Bitbucket is used for
calculating [DORA metrics](../
By default, DevLake will identify the deployment and environment settings that
are defined in the Bitbucket CI .yml file.
-
+
However, to ensure this works properly, you must specify the deployment
settings in the .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.
@@ -176,7 +178,7 @@ All Bitbucket pipeline steps will be saved in table
'cicd_tasks', but DevLake de
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.
- 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
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.
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.
-
+
If a pipeline step defines `deployment` with a value (usually indicating the
environment), this pipeline step is also a Bitbucket deployment.
-
+
###### Additional Settings (Optional)
@@ -211,14 +213,14 @@ Please click `Save` to save the transformation rules for
the repo. In the data s
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.
-
+
### Step 2.2 - Add a Bitbucket Connection
You can add a previously configured Bitbucket connection to the project and
select the boards for which you wish to collect the data for.
Please note: if you don't see the repositories you are looking for, please
check if you have added them to the connection first.
-
+
### Step 2.3 - Set the Sync Policy
@@ -228,7 +230,7 @@ There are three settings for Sync Policy:
- 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.
- 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.
-
+
### Step 2.4 - Start Data Collection
diff --git a/static/img/ConfigUI/bitbucket-add-data-scopes.png
b/static/img/ConfigUI/bitbucket-add-data-scopes.png
new file mode 100644
index 00000000000..1882b887e18
Binary files /dev/null and b/static/img/ConfigUI/bitbucket-add-data-scopes.png
differ
diff --git a/static/img/ConfigUI/bitbucket-ci-entities-overview.png
b/static/img/ConfigUI/bitbucket-ci-entities-overview.png
new file mode 100644
index 00000000000..ac879e77138
Binary files /dev/null and
b/static/img/ConfigUI/bitbucket-ci-entities-overview.png differ
diff --git a/static/img/ConfigUI/bitbucket-deployment-pipeline-history.png
b/static/img/ConfigUI/bitbucket-deployment-pipeline-history.png
new file mode 100644
index 00000000000..4e31617ed80
Binary files /dev/null and
b/static/img/ConfigUI/bitbucket-deployment-pipeline-history.png differ
diff --git a/static/img/ConfigUI/bitbucket-detect-deployments-dora.png
b/static/img/ConfigUI/bitbucket-detect-deployments-dora.png
new file mode 100644
index 00000000000..57fb4b21c9b
Binary files /dev/null and
b/static/img/ConfigUI/bitbucket-detect-deployments-dora.png differ
diff --git a/static/img/ConfigUI/bitbucket-detect-deployments-regex.png
b/static/img/ConfigUI/bitbucket-detect-deployments-regex.png
new file mode 100644
index 00000000000..490901e9148
Binary files /dev/null and
b/static/img/ConfigUI/bitbucket-detect-deployments-regex.png differ
diff --git a/static/img/ConfigUI/bitbucket-issue-status-mapping.png
b/static/img/ConfigUI/bitbucket-issue-status-mapping.png
new file mode 100644
index 00000000000..b605ab68888
Binary files /dev/null and
b/static/img/ConfigUI/bitbucket-issue-status-mapping.png differ
diff --git a/static/img/ConfigUI/bitbucket-pipelines-deployment-settings.png
b/static/img/ConfigUI/bitbucket-pipelines-deployment-settings.png
new file mode 100644
index 00000000000..751801b382f
Binary files /dev/null and
b/static/img/ConfigUI/bitbucket-pipelines-deployment-settings.png differ
