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 8d8d431b9e0 docs: polish the deployment config for Github and GitLab
(#784)
8d8d431b9e0 is described below
commit 8d8d431b9e02991fcd3cba97a3dfcf773894c03f
Author: Louis.z <[email protected]>
AuthorDate: Fri Sep 6 21:55:28 2024 +0800
docs: polish the deployment config for Github and GitLab (#784)
Co-authored-by: Startrekzky <[email protected]>
---
docs/Configuration/GitHub.md | 24 ++++++++++++-------
docs/Configuration/GitLab.md | 26 ++++++++++++++-------
.../images/github-transform-data-2.png | Bin 0 -> 57333 bytes
.../images/github-transform-data-3.png | Bin 0 -> 32997 bytes
docs/Configuration/images/github_workflow_runs.png | Bin 0 -> 202451 bytes
docs/Configuration/images/gitlab-pipeline.png | Bin 0 -> 216068 bytes
.../images/gitlab-transform-data-2.png | Bin 0 -> 53482 bytes
.../images/gitlab-transform-data-3.png | Bin 0 -> 28436 bytes
8 files changed, 33 insertions(+), 17 deletions(-)
diff --git a/docs/Configuration/GitHub.md b/docs/Configuration/GitHub.md
index 89776f32e4d..8af9b255605 100644
--- a/docs/Configuration/GitHub.md
+++ b/docs/Configuration/GitHub.md
@@ -141,20 +141,26 @@ Scope config contains two parts:
- Type/Incident: Same as "Type/Requirement", with `type` setting to "INCIDENT".
#### CI/CD
+
-This set of configurations is used to define 'deployments'. Deployments are
related to measure [DORA metrics](../DORA.md).
+**This is the critical rule for calculating [DORA metrics](../DORA.md) using
GitHub CI/CD entities to define `deployments`.**
-For GitHub deployments, DevLake recognizes them as deployments by specifying a
regular expression (regex) to identify the production environments among all
'GitHub environments'.
+DevLake recognizes deployments from GitHub deployments by using a regular
expression (regex) to pinpoint production environments among all listed GitHub
environments.
-If your deployments are not performed through GitHub deployments but rather
specific workflow runs in GitHub, you have the option to convert a workflow run
into a DevLake deployment. In this case, you need to configure two regular
expressions (regex):
+If your deployments are not performed through GitHub deployments but rather
specific workflow runs in GitHub, you have the option to convert a workflow run
into a DevLake deployment. In this case, you need to check this option and
configure two regular expressions (regex):
-- Deployment: The given regex should match the name of the GitHub 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.
-- Production: The given regex should match either the workflow run's name or
its branch's name to be considered a deployment within the production
environment. For instance:
- - If the workflow run used for deployment is named 'build-to-prod', you can
input (prod). To make the regex case insensitive, you can include (?i) before
the regex.
- - Also, many users in GitHub utilize the same workflow for both staging and
prod deployments, executing it on the release branch would indicate a
production deployment.
+
+
+
+
+- In the first input field, enter the following regex to identify deployments
(highlighted by the yellow rectangle):
+ - The given regex should match the name of the GitHub workflow run or one of
its jobs to be considered as a deployment. The workflow run's name is usually
the same as the name of the workflow run.
+ - For example, if the workflow run used for deployment is named
'build-and-push-image', you can enter `.*push-image.*`. To make the regex case
insensitive, you can include `(?i)` before the regex.
+- In the second input field, enter the following regex to identify production
deployments (highlighted by the red rectangle).
+ - If you use different workflows, such as 'push-image-to-prod' and
'push-image-to-test' to deploy to different environments, enter
`push-image-to-prod` or `.*prod` to define which deployments are PRODUCTION
deployments. To make the regex case insensitive, you can include `(?i)` before
the regex.
+ - If you use the same workflow across different branches for test and
production deployments, enter `release.*` to recognize only runs on the release
branch as PRODUCTION deployments. The regex should match the naming pattern of
your release or production branches.
+ - If left empty, all deployments in the yellow rectangle will be regarded as
Production Deployments.
-
-
#### Code Review
diff --git a/docs/Configuration/GitLab.md b/docs/Configuration/GitLab.md
index a7a60acc78a..7bc26ca90ac 100644
--- a/docs/Configuration/GitLab.md
+++ b/docs/Configuration/GitLab.md
@@ -72,6 +72,8 @@ Select the GitLab repositories you want to collect from the
miller column. **Ple
### Step 1.3 - Add Scope Config (Optional)
+
+
Scope config contains two parts:
- The entities of which domain you wish to collect: Usually, you don't have to
modify this part. However, if you don't want to collect certain GitLab
entities, you can unselect some entities to accelerate the collection speed.
- Issue Tracking: GitLab issues, issue comments, issue labels, etc.
@@ -84,21 +86,29 @@ Scope config contains two parts:
- Without adding transformation rules, you can still view some of the
dashboards.
- Each GitLab repo has at most ONE set of transformations.
-
-
#### CI/CD
+
-This set of configurations is used to define 'deployments'. Deployments are
related to measure [DORA metrics](../DORA.md).
+**This is the critical rule for calculating [DORA metrics](../DORA.md) using
GitLab CI/CD entities to define `deployments`.**
-For GitLab deployments, DevLake recognizes them as deployments by specifying a
regular expression (regex) to identify the production environments among all
'GitLab environments'.
+DevLake recognizes deployments from GitLab deployments by using a regular
expression (regex) to pinpoint production environments among all listed GitLab
environments.
If your deployments are not performed through GitLab deployments but rather
specific pipelines in GitLab, you have the option to convert a GitLab pipeline
run into a DevLake deployment. In this case, you need to configure two regular
expressions (regex):
-- Deployment: The given regex should match the name of the GitLab pipeline's
branch name or one of its job names to be considered as a deployment. For
example, if the pipeline is executet on the 'build-and-push-image', you can
input (push-image). To make the regex case insensitive, you can include (?i)
before the regex.
-- Production: The given regex should match either the pipeline's branch name
or one of its job names to be considered a deployment within the production
environment. For instance:
- - If the pipeline used for deployment is named 'build-to-prod', you can
input (prod). To make the regex case insensitive, you can include (?i) before
the regex.
- - Also, many users in GitLab utilize the same pipeline for both staging and
prod deployments, executing it on the release branch would indicate a
production deployment.
+
+
+
+
+- In the first input field, enter the following regex to identify deployments
(highlighted by the yellow rectangle). For example:
+ - If you consider the pipeline runs that have executed certain job as
deployments, e.g. 'build-image', enter `.*build-image.*` in the input field.
+ - If you only consider the pipeline runs on certain branches (e.g. release
branches or main) as deployments, enter `(release.*|main)` to recognize runs on
these branches as deployments.
+- In the second input field, enter the following regex to identify the
production deployments (highlighted in the red rectangle). If left empty, all
deployments will be regarded as Production Deployments.
+ - If you have two jobs 'build-image-to-test' and 'build-image-to-prod'
matching `.*build-image.*`, and only the pipeline runs that have executed
'build-image-to-prod' should be considered PRODUCTION deployment, you can enter
`.*-prod.*` or `build-image-to-prod`.
+ - If you only consider runs on release branches as PRODUCTION deployments,
enter `release.*` to convert only runs on the release branch as PRODUCTION
deployments. The regex should match the naming pattern of your release or
production branches.
+
+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/github-transform-data-2.png
b/docs/Configuration/images/github-transform-data-2.png
new file mode 100644
index 00000000000..161991c1901
Binary files /dev/null and
b/docs/Configuration/images/github-transform-data-2.png differ
diff --git a/docs/Configuration/images/github-transform-data-3.png
b/docs/Configuration/images/github-transform-data-3.png
new file mode 100644
index 00000000000..a906c058d5d
Binary files /dev/null and
b/docs/Configuration/images/github-transform-data-3.png differ
diff --git a/docs/Configuration/images/github_workflow_runs.png
b/docs/Configuration/images/github_workflow_runs.png
new file mode 100644
index 00000000000..e8b2a8e0918
Binary files /dev/null and b/docs/Configuration/images/github_workflow_runs.png
differ
diff --git a/docs/Configuration/images/gitlab-pipeline.png
b/docs/Configuration/images/gitlab-pipeline.png
new file mode 100644
index 00000000000..f292959f165
Binary files /dev/null and b/docs/Configuration/images/gitlab-pipeline.png
differ
diff --git a/docs/Configuration/images/gitlab-transform-data-2.png
b/docs/Configuration/images/gitlab-transform-data-2.png
new file mode 100644
index 00000000000..c24f0211a38
Binary files /dev/null and
b/docs/Configuration/images/gitlab-transform-data-2.png differ
diff --git a/docs/Configuration/images/gitlab-transform-data-3.png
b/docs/Configuration/images/gitlab-transform-data-3.png
new file mode 100644
index 00000000000..750df44f47c
Binary files /dev/null and
b/docs/Configuration/images/gitlab-transform-data-3.png differ
