Skip to content

Update Code Coverage documentation with Azure DevOps integration details #32011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+39 −10
Open

Update Code Coverage documentation with Azure DevOps integration details #32011

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/en/code_coverage/_index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ algolia:
tags: ["code coverage"]
---

{{< callout url="http://datadoghq.com/product-preview/code-coverage/" >}}
Code Coverage is in Preview. This product replaces Test Optimization's <a href="https://docs.datadoghq.com/tests/code_coverage">code coverage</a> feature, which is being deprecated. Complete the form to request access for the new Code Coverage product.
{{< callout btn_hidden="true" header="false" >}}
Code Coverage is in Preview. This product replaces Test Optimization's <a href="https://docs.datadoghq.com/tests/code_coverage">code coverage</a> feature, which is being deprecated.
{{< /callout >}}

[Code Coverage][1] lets you upload coverage reports to Datadog, visualize aggregated coverage data for pull requests, and block merges based on configurable coverage thresholds.
Expand Down
13 changes: 11 additions & 2 deletions content/en/code_coverage/data_collected.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ further_reading:
text: "Set up Code Coverage"
---

{{< callout url="http://datadoghq.com/product-preview/code-coverage/" >}}
Code Coverage is in Preview. This product replaces Test Optimization's <a href="https://docs.datadoghq.com/tests/code_coverage">code coverage</a> feature, which is being deprecated. Complete the form to request access for the new Code Coverage product.
{{< callout btn_hidden="true" header="false" >}}
Code Coverage is in Preview. This product replaces Test Optimization's <a href="https://docs.datadoghq.com/tests/code_coverage">code coverage</a> feature, which is being deprecated.
{{< /callout >}}

## Source Code Provider Integration
Expand Down Expand Up @@ -42,6 +42,15 @@ See Gitlab's [webhook events and payloads documentation][1] for a detailed descr

[1]: https://docs.gitlab.com/user/project/integrations/webhook_events/

{{% /tab %}}
{{% tab "Azure DevOps" %}}

Code Coverage relies on Azure DevOps webhooks. The webhooks do not include your source code content. They only include metadata about the pull request, such as the title, description, author, labels, and commit SHAs.

See Azure DevOps' [webhook events and payloads documentation][1] for a detailed description of the data sent by webhooks.

[1]: https://learn.microsoft.com/en-us/azure/devops/service-hooks/events?view=azure-devops#git.pullrequest.created

{{% /tab %}}
{{< /tabs >}}

Expand Down
29 changes: 24 additions & 5 deletions content/en/code_coverage/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,8 @@ further_reading:
text: "Learn what data is collected for Code Coverage"
---

{{< callout url="http://datadoghq.com/product-preview/code-coverage/" >}}
Code Coverage is in Preview. This product replaces Test Optimization's <a href="https://docs.datadoghq.com/tests/code_coverage">code coverage</a> feature, which is being deprecated. Complete the form to request access for the new Code Coverage product.
{{< callout btn_hidden="true" header="false" >}}
Code Coverage is in Preview. This product replaces Test Optimization's <a href="https://docs.datadoghq.com/tests/code_coverage">code coverage</a> feature, which is being deprecated.
{{< /callout >}}

Setting up Code Coverage involves the following steps:
Expand All @@ -28,7 +28,7 @@ Code Coverage supports the following:
{{< tabs >}}
{{% tab "GitHub" %}}

See the [GitHub integration documentation][1] for detailed instructions for integrating with GitHub.
Follow instructions in the [GitHub integration documentation][1] on how to connect your GitHub repositories to Datadog.

Code Coverage requires the following GitHub App permissions:
| Permission | Access Level | Purpose |
Expand All @@ -55,9 +55,22 @@ If everything is configured correctly, a green check mark is displayed in Datado
{{% /tab %}}
{{% tab "Gitlab" %}}

Follow instructions in the [Datadog Source Code Integration Guide][1] on how to connect your Gitlab repositories to Datadog.
Follow instructions in the [Gitlab Source Code integration documentation][1] on how to connect your Gitlab repositories to Datadog.

[1]: /integrations/guide/source-code-integration/?tab=gitlabsaasonprem#connect-your-git-repositories-to-datadog
See [Datadog Source Code Integration Guide][2] for additional context.

[1]: /integrations/gitlab-source-code/
[2]: /integrations/guide/source-code-integration/?tab=gitlabsaasonprem#connect-your-git-repositories-to-datadog
[2]: https://app.datadoghq.com/integrations/gitlab-source-code

{{% /tab %}}
{{% tab "Azure DevOps" %}}

Follow instructions in the [Datadog Source Code Integration Guide][1] on how to connect your Azure DevOps repositories to Datadog
using [Azure DevOps Source Code integration][2].

[1]: /integrations/guide/source-code-integration/?tab=azuredevopssaasonly#connect-your-git-repositories-to-datadog
[2]: https://app.datadoghq.com/integrations/azure-devops-source-code/

{{% /tab %}}
{{< /tabs >}}
Expand Down Expand Up @@ -302,6 +315,11 @@ Start-Process -FilePath "./datadog-ci.exe" -ArgumentList version
{{% /tab %}}
{{< /tabs >}}

#### Docker image

Alternatively, you can update your CI job to run in a container based on the [Datadog CI Docker image][13].
The image comes with `datadog-ci` preinstalled and ready to use.

### Uploading coverage reports

<div class="alert alert-info">
Expand Down Expand Up @@ -425,3 +443,4 @@ Datadog deduplicates overlapping files across reports, which can result in diffe
[10]: https://github.com/DataDog/datadog-ci/blob/master/packages/datadog-ci/src/commands/coverage/README.md
[11]: https://app.datadoghq.com/ci/code-coverage
[12]: #integrate-with-source-code-provider
[13]: https://hub.docker.com/r/datadog/ci
3 changes: 2 additions & 1 deletion content/en/integrations/guide/source-code-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,10 @@ Install Datadog's [GitLab Source Code integration][101] using the [integration t
Repositories from Azure DevOps are supported in closed Preview. <a href="https://www.datadoghq.com/product-preview/azure-devops-integration-code-security/">Join the Preview</a>.
</div>

Install Datadog's Azure DevOps Source Code integration while onboarding to [Datadog Code Security][101]. This integration's functionality is limited to Code Security.
Install Datadog's Azure DevOps Source Code integration using the [integration tile][102] or while onboarding to [Datadog Code Security][101].

[101]: https://app.datadoghq.com/security/configuration/code-security/setup?provider=azure-devops&steps=static
[102]: https://app.datadoghq.com/integrations/azure-devops-source-code/

{{% /tab %}}
{{% tab "Other SCM Providers" %}}
Expand Down
Loading