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 372a6cd4033 docs: add CircleCI scope config (#769)
372a6cd4033 is described below
commit 372a6cd4033cc22cabdb1a39b7adfcb0cb498795
Author: Louis.z <[email protected]>
AuthorDate: Mon Jun 24 20:49:46 2024 +0800
docs: add CircleCI scope config (#769)
Co-authored-by: Startrekzky <[email protected]>
---
docs/Configuration/CircleCI.md | 23 +++++++++++++++++++--
.../images/circleci-scope-config-1.png | Bin 0 -> 135900 bytes
.../images/circleci-scope-config-2.png | Bin 0 -> 53260 bytes
.../version-v1.0/Configuration/CircleCI.md | 22 ++++++++++++++++++--
.../images/circleci-scope-config-1.png | Bin 0 -> 135900 bytes
.../images/circleci-scope-config-2.png | Bin 0 -> 53260 bytes
6 files changed, 41 insertions(+), 4 deletions(-)
diff --git a/docs/Configuration/CircleCI.md b/docs/Configuration/CircleCI.md
index 4cafaefd68f..4b1b8dd43ef 100644
--- a/docs/Configuration/CircleCI.md
+++ b/docs/Configuration/CircleCI.md
@@ -53,8 +53,27 @@ Click `Test Connection`, if the connection is successful,
click `Save Connection
Select the CircleCI projects to collect.
### Step 1.3 - Adding Scope Config (Optional)
-
-You can add a `transformation` to standardize the data. A `transformation`
acts on the CircleCI data in the [tool
layer](/docs/DataModels/ToolLayerSchema.md), transforming it to the [domain
layer](/docs/DataModels/DevLakeDomainLayerSchema.md).
+Scope config includes two sets of configurations:
+- Data Entities
+- Transformations
+
+##### Data Entities
+
+
+CircleCI only supports `CI/CD` domain entities, which include CircleCI
`projects`, `workflows`, `jobs`, and etc.
+
+
+##### Transformations
+
+
+
+This set of configurations is used for calculating [DORA metrics](../DORA.md).
+
+You can transform a CircleCI workflow run into a DevLake deployment with the
following regex:
+
+- Deployment: The given regex should match the name of the Circle workflow run
or one of its jobs to be considered as a deployment. For example, if the
workflow run used for deployment is named 'build-and-push-image', you can input
`(push-image)`. To make the regex case insensitive, you can include `(?i)`
before the regex.
+- Environment: The given regex should match the workflow run's name to be
considered a deployment within the production environment. For instance, if the
workflow run used for deployment is named 'deploy-to-prod', you can input
`(prod)`. To make the regex case insensitive, you can include (?i) before the
regex.
+
## Step 2 - Collect Data in a Project
### Step 2.1 - Create a Project
diff --git a/docs/Configuration/images/circleci-scope-config-1.png
b/docs/Configuration/images/circleci-scope-config-1.png
new file mode 100644
index 00000000000..c617b212763
Binary files /dev/null and
b/docs/Configuration/images/circleci-scope-config-1.png differ
diff --git a/docs/Configuration/images/circleci-scope-config-2.png
b/docs/Configuration/images/circleci-scope-config-2.png
new file mode 100644
index 00000000000..89914e27773
Binary files /dev/null and
b/docs/Configuration/images/circleci-scope-config-2.png differ
diff --git a/versioned_docs/version-v1.0/Configuration/CircleCI.md
b/versioned_docs/version-v1.0/Configuration/CircleCI.md
index 4cafaefd68f..123dfbcd167 100644
--- a/versioned_docs/version-v1.0/Configuration/CircleCI.md
+++ b/versioned_docs/version-v1.0/Configuration/CircleCI.md
@@ -53,8 +53,26 @@ Click `Test Connection`, if the connection is successful,
click `Save Connection
Select the CircleCI projects to collect.
### Step 1.3 - Adding Scope Config (Optional)
-
-You can add a `transformation` to standardize the data. A `transformation`
acts on the CircleCI data in the [tool
layer](/docs/DataModels/ToolLayerSchema.md), transforming it to the [domain
layer](/docs/DataModels/DevLakeDomainLayerSchema.md).
+Scope config includes two sets of configurations:
+- Data Entities
+- Transformations
+
+##### Data Entities
+
+
+CircleCI only supports `CI/CD` domain entities, which include CircleCI
`projects`, `workflows`, `jobs`, and etc.
+
+
+##### Transformations
+
+
+
+This set of configurations is used for calculating [DORA metrics](../DORA.md).
+
+You can transform a CircleCI workflow run into a DevLake deployment with the
following regex:
+
+- Deployment: The given regex should match the name of the Circle workflow run
or one of its jobs to be considered as a deployment. For example, if the
workflow run used for deployment is named 'build-and-push-image', you can input
`(push-image)`. To make the regex case insensitive, you can include `(?i)`
before the regex.
+- Environment: The given regex should match the workflow run's name to be
considered a deployment within the production environment. For instance, if the
workflow run used for deployment is named 'deploy-to-prod', you can input
`(prod)`. To make the regex case insensitive, you can include (?i) before the
regex.
## Step 2 - Collect Data in a Project
### Step 2.1 - Create a Project
diff --git
a/versioned_docs/version-v1.0/Configuration/images/circleci-scope-config-1.png
b/versioned_docs/version-v1.0/Configuration/images/circleci-scope-config-1.png
new file mode 100644
index 00000000000..c617b212763
Binary files /dev/null and
b/versioned_docs/version-v1.0/Configuration/images/circleci-scope-config-1.png
differ
diff --git
a/versioned_docs/version-v1.0/Configuration/images/circleci-scope-config-2.png
b/versioned_docs/version-v1.0/Configuration/images/circleci-scope-config-2.png
new file mode 100644
index 00000000000..89914e27773
Binary files /dev/null and
b/versioned_docs/version-v1.0/Configuration/images/circleci-scope-config-2.png
differ
