From 32d015d0821cb6e405a14a59be28c5b242b6be2b Mon Sep 17 00:00:00 2001 From: Henry Walsh <50926470+henrywalsh@users.noreply.github.com> Date: Mon, 3 Mar 2025 17:05:44 +0100 Subject: [PATCH 01/10] SDCD-887: updating DORA setup documentation to include GitLab, which is in closed preview --- content/en/dora_metrics/setup/deployments.md | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/content/en/dora_metrics/setup/deployments.md b/content/en/dora_metrics/setup/deployments.md index cdc6993e83916..1b726e7a93f7d 100644 --- a/content/en/dora_metrics/setup/deployments.md +++ b/content/en/dora_metrics/setup/deployments.md @@ -192,6 +192,17 @@ To confirm that the setup is valid, select your GitHub application in the [GitHu [2]: https://app.datadoghq.com/integrations/github/ {{% /tab %}} +{{% tab "GitLab" %}} +Datadog's GitLab integration is currently in closed preview. To request access for your organization, please reach out to [Datadog Support][1]. + +Once your organization has access, follow the [GitLab installation guide][2]. + +**Note**: The scope of the service account's personal access token needs to be at least **read_api**. + +[1]: https://www.datadoghq.com/support/ +[2]: https://github.com/DataDog/gitlab-integration-setup?tab=readme-ov-file#datadog--gitlab-integration-installation-guide +{{% /tab %}} + {{% tab "Other Git Providers" %}} You can upload your Git repository metadata with the [`datadog-ci git-metadata upload`][1] command. @@ -252,7 +263,8 @@ If the two metadata entries are defined for a service, only `extensions[datadogh ### Limitations -- Change lead time stage breakdown metrics are only available for GitHub. +- Change lead time stage breakdown metrics are only available for GitHub and GitLab. + - The GitLab integration is currently in closed preview. Access can be requested [here][8]. - Change lead time is not available for the first deployment of a service that includes Git information. - The Change Lead Time calculation includes a maximum of 5000 commits per deployment. - For rebased branches, *change lead time* calculations consider the new commits created during the rebase, not the original commits. @@ -275,3 +287,4 @@ Change failure rate is calculated by dividing `dora.incidents.count` over `dora. [5]: /tracing/software_catalog/adding_metadata [6]: https://git-scm.com/docs/git-log [7]: /dora_metrics/data_collected +[8]: https://www.datadoghq.com/support/ From 1ff2b7994f28fd7d7d1b216c405ef88ce49e2258 Mon Sep 17 00:00:00 2001 From: Henry Walsh <50926470+henrywalsh@users.noreply.github.com> Date: Tue, 4 Mar 2025 10:26:19 +0100 Subject: [PATCH 02/10] SDCD-887: updating wording based on automated PR feedback --- content/en/dora_metrics/setup/deployments.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/dora_metrics/setup/deployments.md b/content/en/dora_metrics/setup/deployments.md index 1b726e7a93f7d..252c88603c926 100644 --- a/content/en/dora_metrics/setup/deployments.md +++ b/content/en/dora_metrics/setup/deployments.md @@ -193,9 +193,9 @@ To confirm that the setup is valid, select your GitHub application in the [GitHu {{% /tab %}} {{% tab "GitLab" %}} -Datadog's GitLab integration is currently in closed preview. To request access for your organization, please reach out to [Datadog Support][1]. +Datadog's GitLab integration is currently in closed preview. To request access for your organization, reach out to [Datadog Support][1]. -Once your organization has access, follow the [GitLab installation guide][2]. +After your organization has access, follow the [GitLab installation guide][2]. **Note**: The scope of the service account's personal access token needs to be at least **read_api**. From 5ed9f39cf8e19c0497e1c8bed45f3338f05c4866 Mon Sep 17 00:00:00 2001 From: Henry Walsh <50926470+henrywalsh@users.noreply.github.com> Date: Tue, 4 Mar 2025 10:27:16 +0100 Subject: [PATCH 03/10] SDCD-887: removing "currently" as requested by the automated suggestion --- content/en/dora_metrics/setup/deployments.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/dora_metrics/setup/deployments.md b/content/en/dora_metrics/setup/deployments.md index 252c88603c926..827fc73c7669a 100644 --- a/content/en/dora_metrics/setup/deployments.md +++ b/content/en/dora_metrics/setup/deployments.md @@ -193,7 +193,7 @@ To confirm that the setup is valid, select your GitHub application in the [GitHu {{% /tab %}} {{% tab "GitLab" %}} -Datadog's GitLab integration is currently in closed preview. To request access for your organization, reach out to [Datadog Support][1]. +Datadog's GitLab integration is in closed preview. To request access for your organization, reach out to [Datadog Support][1]. After your organization has access, follow the [GitLab installation guide][2]. @@ -264,7 +264,7 @@ If the two metadata entries are defined for a service, only `extensions[datadogh ### Limitations - Change lead time stage breakdown metrics are only available for GitHub and GitLab. - - The GitLab integration is currently in closed preview. Access can be requested [here][8]. + - The GitLab integration is in closed preview. Access can be requested [here][8]. - Change lead time is not available for the first deployment of a service that includes Git information. - The Change Lead Time calculation includes a maximum of 5000 commits per deployment. - For rebased branches, *change lead time* calculations consider the new commits created during the rebase, not the original commits. From 03f992ad2d503508f671d934f5bfdcf35a41bf59 Mon Sep 17 00:00:00 2001 From: Henry Walsh <50926470+henrywalsh@users.noreply.github.com> Date: Tue, 4 Mar 2025 11:24:19 +0100 Subject: [PATCH 04/10] SDCD-887: moving closed preview message to alert-warning div --- content/en/dora_metrics/setup/deployments.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/content/en/dora_metrics/setup/deployments.md b/content/en/dora_metrics/setup/deployments.md index 827fc73c7669a..77ea98822d511 100644 --- a/content/en/dora_metrics/setup/deployments.md +++ b/content/en/dora_metrics/setup/deployments.md @@ -193,7 +193,9 @@ To confirm that the setup is valid, select your GitHub application in the [GitHu {{% /tab %}} {{% tab "GitLab" %}} -Datadog's GitLab integration is in closed preview. To request access for your organization, reach out to [Datadog Support][1]. +
Datadog's GitLab integration is in closed preview.
+ +To request access to Datadog's GitLab integration for your organization, reach out to [Datadog Support][1]. After your organization has access, follow the [GitLab installation guide][2]. From 96223c810b8e99a5749e9404f9395ea53448b309 Mon Sep 17 00:00:00 2001 From: Henry Walsh <50926470+henrywalsh@users.noreply.github.com> Date: Wed, 5 Mar 2025 10:14:04 +0100 Subject: [PATCH 05/10] Update deployments.md --- content/en/dora_metrics/setup/deployments.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/content/en/dora_metrics/setup/deployments.md b/content/en/dora_metrics/setup/deployments.md index 77ea98822d511..06c0593d8d157 100644 --- a/content/en/dora_metrics/setup/deployments.md +++ b/content/en/dora_metrics/setup/deployments.md @@ -193,13 +193,11 @@ To confirm that the setup is valid, select your GitHub application in the [GitHu {{% /tab %}} {{% tab "GitLab" %}} -
Datadog's GitLab integration is in closed preview.
- -To request access to Datadog's GitLab integration for your organization, reach out to [Datadog Support][1]. +
Datadog's GitLab integration is in Preview. To request access to Datadog's GitLab integration for your organization, reach out to [Datadog Support][1].
After your organization has access, follow the [GitLab installation guide][2]. -**Note**: The scope of the service account's personal access token needs to be at least **read_api**. +**Note**: The scope of the service account's personal access token needs to be at least `read_api`. [1]: https://www.datadoghq.com/support/ [2]: https://github.com/DataDog/gitlab-integration-setup?tab=readme-ov-file#datadog--gitlab-integration-installation-guide @@ -266,7 +264,7 @@ If the two metadata entries are defined for a service, only `extensions[datadogh ### Limitations - Change lead time stage breakdown metrics are only available for GitHub and GitLab. - - The GitLab integration is in closed preview. Access can be requested [here][8]. + - The GitLab integration is in Preview. Contact [Datadog support][8] to request access. - Change lead time is not available for the first deployment of a service that includes Git information. - The Change Lead Time calculation includes a maximum of 5000 commits per deployment. - For rebased branches, *change lead time* calculations consider the new commits created during the rebase, not the original commits. From 0cab605d8e0b9fbbb808fbe82042ea6bd486e85b Mon Sep 17 00:00:00 2001 From: May Lee Date: Wed, 5 Mar 2025 10:17:21 -0500 Subject: [PATCH 06/10] fix link --- content/en/dora_metrics/setup/deployments.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/content/en/dora_metrics/setup/deployments.md b/content/en/dora_metrics/setup/deployments.md index 06c0593d8d157..830cb2598b785 100644 --- a/content/en/dora_metrics/setup/deployments.md +++ b/content/en/dora_metrics/setup/deployments.md @@ -193,14 +193,13 @@ To confirm that the setup is valid, select your GitHub application in the [GitHu {{% /tab %}} {{% tab "GitLab" %}} -
Datadog's GitLab integration is in Preview. To request access to Datadog's GitLab integration for your organization, reach out to [Datadog Support][1].
+
Datadog's GitLab integration is in Preview. To request access to Datadog's GitLab integration for your organization, reach out to Datadog Support.
-After your organization has access, follow the [GitLab installation guide][2]. +After your organization has access, follow the [GitLab installation guide][1]. **Note**: The scope of the service account's personal access token needs to be at least `read_api`. -[1]: https://www.datadoghq.com/support/ -[2]: https://github.com/DataDog/gitlab-integration-setup?tab=readme-ov-file#datadog--gitlab-integration-installation-guide +[1]: https://github.com/DataDog/gitlab-integration-setup?tab=readme-ov-file#datadog--gitlab-integration-installation-guide {{% /tab %}} {{% tab "Other Git Providers" %}} From ef8708b2fb00bbd0cb53d118123c1a0a1f0b0d37 Mon Sep 17 00:00:00 2001 From: Henry Walsh <50926470+henrywalsh@users.noreply.github.com> Date: Thu, 13 Mar 2025 17:21:50 +0100 Subject: [PATCH 07/10] SDCD-887: adding GitLab information in the file path spec section of the docs --- content/en/dora_metrics/setup/deployments.md | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/content/en/dora_metrics/setup/deployments.md b/content/en/dora_metrics/setup/deployments.md index 830cb2598b785..bb4383127de22 100644 --- a/content/en/dora_metrics/setup/deployments.md +++ b/content/en/dora_metrics/setup/deployments.md @@ -232,10 +232,11 @@ If the source code of multiple services is present in the same repository, furth To filter the commits measured to only the ones that affect the service, specify the source code glob file path patterns in the [service definition][5]. -If the service definition contains a **full** GitHub URL to the application folder, a single path pattern is automatically used. +If the service definition contains a **full** GitHub or GitLab URL to the application folder, a single path pattern is automatically used. **Example (schema version v2.2):** - +{{< tabs >}} +{{% tab "GitHub" %}} ```yaml links: - name: shopist @@ -243,6 +244,17 @@ links: provider: github url: https://github.com/organization/example-repository/tree/main/src/apps/shopist ``` +{{% /tab %}} +{{% tab "GitLab" %}} +```yaml +links: + - name: shopist + type: repo + provider: gitlab + url: https://gitlab.com/organization/example-repository/-/tree/main/src/apps/shopist?ref_type=heads +``` +{{% /tab %}} +{{< tabs >}} DORA Metrics for the `shopist` service only consider the Git commits that include changes within `src/apps/shopist/**`. You can configure more granular control of the filtering with `extensions[datadoghq.com/dora-metrics]`. @@ -268,7 +280,7 @@ If the two metadata entries are defined for a service, only `extensions[datadogh - The Change Lead Time calculation includes a maximum of 5000 commits per deployment. - For rebased branches, *change lead time* calculations consider the new commits created during the rebase, not the original commits. - When using "Squash" to merge pull requests: - - For GitHub: Metrics are emitted for the original commits. + - For GitHub and GitLab: Metrics are emitted for the original commits. - For other git providers: Metrics are emitted for the new commit added to the target branch. ## Calculating change failure rate From f92a4db948a826096da8cb5b8b9b109152d816f6 Mon Sep 17 00:00:00 2001 From: Henry Walsh <50926470+henrywalsh@users.noreply.github.com> Date: Fri, 14 Mar 2025 10:26:28 +0100 Subject: [PATCH 08/10] SDCD-887: adding missing `/` in when closing tabs section --- content/en/dora_metrics/setup/deployments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/dora_metrics/setup/deployments.md b/content/en/dora_metrics/setup/deployments.md index bb4383127de22..e8548dc170323 100644 --- a/content/en/dora_metrics/setup/deployments.md +++ b/content/en/dora_metrics/setup/deployments.md @@ -254,7 +254,7 @@ links: url: https://gitlab.com/organization/example-repository/-/tree/main/src/apps/shopist?ref_type=heads ``` {{% /tab %}} -{{< tabs >}} +{{< /tabs >}} DORA Metrics for the `shopist` service only consider the Git commits that include changes within `src/apps/shopist/**`. You can configure more granular control of the filtering with `extensions[datadoghq.com/dora-metrics]`. From 0b2de0d20e82ecc444c75900bf68e4326e763087 Mon Sep 17 00:00:00 2001 From: Henry Walsh <50926470+henrywalsh@users.noreply.github.com> Date: Mon, 17 Mar 2025 10:21:07 +0100 Subject: [PATCH 09/10] Update content/en/dora_metrics/setup/deployments.md Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com> --- content/en/dora_metrics/setup/deployments.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/en/dora_metrics/setup/deployments.md b/content/en/dora_metrics/setup/deployments.md index 7e0d6a297c5cc..ca6b02cb4704a 100644 --- a/content/en/dora_metrics/setup/deployments.md +++ b/content/en/dora_metrics/setup/deployments.md @@ -275,7 +275,6 @@ If the two metadata entries are defined for a service, only `extensions[datadogh ### Limitations - Change lead time stage breakdown metrics are only available for GitHub and GitLab. - - The GitLab integration is in Preview. Contact [Datadog support][8] to request access. - Change lead time is not available for the first deployment of a service that includes Git information. - The Change Lead Time calculation includes a maximum of 5000 commits per deployment. - For rebased branches, *change lead time* calculations consider the new commits created during the rebase, not the original commits. From d0805a60099f5f70de91836dd12f135cb3a418d3 Mon Sep 17 00:00:00 2001 From: Henry Walsh <50926470+henrywalsh@users.noreply.github.com> Date: Mon, 17 Mar 2025 10:21:14 +0100 Subject: [PATCH 10/10] Update content/en/dora_metrics/setup/deployments.md Co-authored-by: Janine Chan <64388808+janine-c@users.noreply.github.com> --- content/en/dora_metrics/setup/deployments.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/dora_metrics/setup/deployments.md b/content/en/dora_metrics/setup/deployments.md index ca6b02cb4704a..81a81e079ab0b 100644 --- a/content/en/dora_metrics/setup/deployments.md +++ b/content/en/dora_metrics/setup/deployments.md @@ -280,7 +280,7 @@ If the two metadata entries are defined for a service, only `extensions[datadogh - For rebased branches, *change lead time* calculations consider the new commits created during the rebase, not the original commits. - When using "Squash" to merge pull requests: - For GitHub and GitLab: Metrics are emitted for the original commits. - - For other git providers: Metrics are emitted for the new commit added to the target branch. + - For other Git providers: Metrics are emitted for the new commit added to the target branch. ## Calculating change failure rate