Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion content/en/continuous_delivery/deployments/argocd.md
Original file line number Diff line number Diff line change
Expand Up @@ -271,7 +271,7 @@ If notifications are not sent, examine the logs of the `argocd-notification-cont
[11]: https://app.datadoghq.com/organization-settings/api-keys
[12]: https://argo-cd.readthedocs.io/en/stable/operator-manual/notifications/subscriptions/
[13]: /tracing/software_catalog
[14]: https://github.com/DataDog/datadog-ci/tree/master/src/commands/deployment#correlate
[14]: https://github.com/DataDog/datadog-ci/tree/master/packages/plugin-deployment#correlate
[15]: /containers/kubernetes
[16]: https://app.datadoghq.com/orchestration/explorer
[17]: https://argo-cd.readthedocs.io/en/stable/user-guide/best_practices/#separating-config-vs-source-code-repositories
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Reporting commit 007f7f466e035b052415134600ea899693e7bb34 from repository git@gi
✅ Handled in 0.077 seconds.
```

[1]: https://github.com/DataDog/datadog-ci/tree/master/src/commands/git-metadata
[1]: https://github.com/DataDog/datadog-ci/tree/master/packages/base/src/commands/git-metadata
{{% /tab %}}
{{< /tabs >}}

Expand Down Expand Up @@ -168,9 +168,9 @@ extensions:
- "**"
```

In this case, Code Changes Detection for deployments of the `shopist` service will consider the Git commits that include changes in the whole repository tree.
In this case, Code Changes Detection for deployments of the `shopist` service will consider the Git commits that include changes in the whole repository tree.

<div class="alert alert-warning">If a pattern is exactly <code>**</code> or begins with it, enclose it in quotes, as <code>*</code> is reserved in YAML for anchors.</div>
<div class="alert alert-warning">If a pattern is exactly <code>**</code> or begins with it, enclose it in quotes, as <code>*</code> is reserved in YAML for anchors.</div>


## Further Reading
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,5 @@ When images are properly correlated, Datadog populates a version tag from the im
{{< partial name="whats-next/whats-next.html" >}}

[1]: https://app.datadoghq.com/ci/deployments/executions
[2]: https://github.com/DataDog/datadog-ci/tree/master/src/commands/deployment#correlate
[2]: https://github.com/DataDog/datadog-ci/tree/master/packages/plugin-deployment#correlate
[3]: /continuous_delivery/deployments/argocd#correlate-deployments-with-ci-pipelines
18 changes: 9 additions & 9 deletions content/en/continuous_testing/cicd_integrations/gitlab.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,37 +32,37 @@ For more information, see [CI/CD Integrations Configuration][4].
### Run tests using test IDs

{{< code-block lang="yaml" >}}
stages:
stages:
- test
synthetic-tests:
stage: test
script:
script:
- npm install -g @datadog/datadog-ci
- datadog-ci synthetics run-tests --apiKey "$DATADOG_API_KEY" --appKey "$DATADOG_APP_KEY" --public-id xtf-w5p-z5n --public-id eif-van-tu7
{{< /code-block >}}

### Run tests using tags

{{< code-block lang="yaml" >}}
stages:
stages:
- test
synthetic-tests:
stage: test
script:
script:
- npm install -g @datadog/datadog-ci
- datadog-ci synthetics run-tests --apiKey "$DATADOG_API_KEY" --appKey "$DATADOG_APP_KEY" -s 'tag:e2e-tests'
{{< /code-block >}}

### Run tests using variable overrides

If you have different test users or data specific to your CI/CD environment, you can override these variables with the `-v` command. For more information, [see the Synthetics command](https://github.com/DataDog/datadog-ci/tree/master/src/commands/synthetics) in the `datadog-ci` NPM package.
If you have different test users or data specific to your CI/CD environment, you can override these variables with the `-v` command. For more information, [see the Synthetics command](https://github.com/DataDog/datadog-ci/tree/master/packages/plugin-synthetics) in the `datadog-ci` NPM package.

{{< code-block lang="yaml" >}}
stages:
stages:
- test
synthetic-tests:
stage: test
script:
script:
- npm install -g @datadog/datadog-ci
- datadog-ci synthetics run-tests --apiKey "$DATADOG_API_KEY" --appKey "$DATADOG_APP_KEY" -s 'tag:e2e-tests' -v PASSWORD="$PASSWORD"
{{< /code-block >}}
Expand All @@ -74,11 +74,11 @@ synthetic-tests:
Add a custom `config.json` file to your pipeline repository and access it in your pipeline configuration.

{{< code-block lang="yaml" >}}
stages:
stages:
- test
synthetic-tests:
stage: test
script:
script:
- npm install -g @datadog/datadog-ci
- datadog-ci synthetics run-tests --apiKey "$DATADOG_API_KEY" --appKey "$DATADOG_APP_KEY" --config synthetics_global.json -f synthetic_test.json
{{< /code-block >}}
Expand Down
4 changes: 2 additions & 2 deletions content/en/deployment_gates/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ For complete configuration options and detailed usage examples, refer to the [`d
[1]: https://github.com/DataDog/datadog-ci
[2]: https://app.datadoghq.com/organization-settings/api-keys
[3]: https://app.datadoghq.com/organization-settings/application-keys
[4]: https://github.com/DataDog/datadog-ci/tree/master/packages/datadog-ci/src/commands/deployment#gate
[4]: https://github.com/DataDog/datadog-ci/tree/master/packages/plugin-deployment#gate

{{% /tab %}}
{{% tab "Argo Rollouts" %}}
Expand Down Expand Up @@ -234,7 +234,7 @@ spec:
[4]: https://argo-rollouts.readthedocs.io/en/stable/features/analysis/#analysis-template-arguments
[5]: https://app.datadoghq.com/organization-settings/api-keys
[6]: https://app.datadoghq.com/organization-settings/application-keys
[7]: https://github.com/DataDog/datadog-ci/tree/master/packages/datadog-ci/src/commands/deployment#gate
[7]: https://github.com/DataDog/datadog-ci/tree/master/packages/plugin-deployment#gate

{{% /tab %}}
{{% tab "Generic script" %}}
Expand Down
2 changes: 1 addition & 1 deletion content/en/dora_metrics/setup/deployments.md
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ Reporting commit 007f7f466e035b052415134600ea899693e7bb34 from repository git@gi
✅ Handled in 0.077 seconds.
```

[1]: https://github.com/DataDog/datadog-ci/tree/master/src/commands/git-metadata
[1]: https://github.com/DataDog/datadog-ci/tree/master/packages/base/src/commands/git-metadata
{{% /tab %}}
{{< /tabs >}}

Expand Down
2 changes: 1 addition & 1 deletion content/en/glossary/terms/test_suite.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ core_product:
related_terms:
- test service
---
In Datadog Synthetic Monitoring and Test Optimization, a test suite is generally a group of tests exercising the same unit of code depending on your language and testing framework. You can access an <a href="https://github.com/DataDog/datadog-ci/blob/master/src/commands/junit/__tests__/upload.test.ts">example of a test suite</a> which corresponds to a test file in the `datadog-ci` repository. For more information, <a href="/tests/#supported-features">see the documentation</a>.
In Datadog Synthetic Monitoring and Test Optimization, a test suite is generally a group of tests exercising the same unit of code depending on your language and testing framework. You can access an <a href="https://github.com/DataDog/datadog-ci/blob/master/packages/datadog-ci/src/commands/junit/__tests__/upload.test.ts">example of a test suite</a> which corresponds to a test file in the `datadog-ci` repository. For more information, <a href="/tests/#supported-features">see the documentation</a>.
14 changes: 7 additions & 7 deletions content/en/integrations/guide/source-code-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,8 @@ Datadog supports the following features for the following source code management
| **Connect SaaS Instance** | Yes <br />(GitHub.com and GitHub Enterprise Cloud) | Yes <br />(GitLab.com) | Yes <br />(Azure DevOps Services) | No <br />(Bitbucket.org) |
| **Connect On-Prem Instance** | Yes <br />(GitHub Enterprise Server) | Yes <br />(GitLab Self-Managed or Dedicated) | No <br />(Azure DevOps Server) | No <br />(Bitbucket Data Center or Server)|
| **Context Links** | Yes | Yes | Yes | Yes |
| **Code Snippets** | Yes | Yes | Yes | No |
| **PR Comments** | Yes | Yes | Yes | No |
| **Code Snippets** | Yes | Yes | Yes | No |
| **PR Comments** | Yes | Yes | Yes | No |

{{< tabs >}}
{{% tab "GitHub (SaaS & On-Prem)" %}}
Expand Down Expand Up @@ -117,7 +117,7 @@ Successfully synced git DB in 3.579 seconds.
✅ Uploaded in 5.207 seconds.
```

[1]: https://github.com/DataDog/datadog-ci/tree/master/src/commands/git-metadata
[1]: https://github.com/DataDog/datadog-ci/tree/master/packages/base/src/commands/git-metadata
{{% /tab %}}
{{< /tabs >}}

Expand Down Expand Up @@ -577,7 +577,7 @@ For more information, see the [Dynamic Instrumentation documentation][102].

{{< tabs >}}
{{% tab "CI Visibility" %}}
PR comments are enabled by default when first onboarding to CI Visibility if the GitHub or GitLab integration is installed correctly. These integrations post a comment summarizing the failed jobs detected in your pull request.
PR comments are enabled by default when first onboarding to CI Visibility if the GitHub or GitLab integration is installed correctly. These integrations post a comment summarizing the failed jobs detected in your pull request.

{{< img src="integrations/guide/source_code_integration/ci-visibility-pr-comment.png" alt="PR Comment summarizing failed jobs detected by CI Visibility" style="width:100%;">}}

Expand All @@ -588,9 +588,9 @@ To disable PR comments for CI Visibility, go to the [CI Visibility Repository Se
{{% /tab %}}
{{% tab "Code Security" %}}

PR comments are enabled by default when first onboarding to Code Security if the GitHub, GitLab, or Azure DevOps integration is installed correctly. These integrations post two types of comments on your pull requests:
PR comments are enabled by default when first onboarding to Code Security if the GitHub, GitLab, or Azure DevOps integration is installed correctly. These integrations post two types of comments on your pull requests:

1. A single comment summarizing the new violations detected in your pull request.
1. A single comment summarizing the new violations detected in your pull request.

{{< img src="integrations/guide/source_code_integration/code-security-summary-pr-comment.png" alt="PR Comment summarizing the new violations detected by Code Security" style="width:100%;">}}

Expand All @@ -605,7 +605,7 @@ To disable PR comments for Code Security, go to the [Code Security Repository Se
{{% /tab %}}
{{% tab "Test Optimization" %}}

PR comments are enabled by default when first onboarding to Test Optimization if the GitHub or GitLab integration is installed correctly. The integration posts a comment summarizing the failed and flaky tests detected in your pull request.
PR comments are enabled by default when first onboarding to Test Optimization if the GitHub or GitLab integration is installed correctly. The integration posts a comment summarizing the failed and flaky tests detected in your pull request.

{{< img src="integrations/guide/source_code_integration/test-optimization-pr-comment.png" alt="PR Comment summarizing failed and flaky tests detected by Test Optimization" style="width:100%;">}}

Expand Down
14 changes: 7 additions & 7 deletions content/en/quality_gates/setup/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,19 +27,19 @@ To create a Quality Gates rule in Datadog:

You can create a rule that is evaluated only on specific repositories and branches. To customize the rule scope, click `Select when to evaluate` and specify the branch or repository that should be included or excluded.

To add a custom scope (such as a team name), click **+ Add Filter** and select **Custom scope**. Enter a tag name without spaces (such as `documentation` or `team-documentation`) and click **Add Custom Scope**. Enter values that should be included or excluded.
To add a custom scope (such as a team name), click **+ Add Filter** and select **Custom scope**. Enter a tag name without spaces (such as `documentation` or `team-documentation`) and click **Add Custom Scope**. Enter values that should be included or excluded.

When adding a custom scope to a rule, custom scopes must be passed to the `datadog-ci gate evaluate` command using the `--scope` option. For more information, see [Understanding Rule Scopes][13].

4. Define the rule conditions. The rule condition states in which scenario the rule fails, failing the related pipeline (if the rule is blocking). You can select one of the existing rule conditions for the rule type you have selected. If the rule scope is set to `always evaluate`, the rule is evaluated on all repositories and branches.

The following example demonstrates how to create a Static Analysis rule that fails when one or more Static Analysis code quality violations with `error` status are contained within a repository.

Select **Static Analysis** for the rule type and click `Always evaluate` for the rule scope.
Select **Static Analysis** for the rule type and click `Always evaluate` for the rule scope.

{{< img src="quality_gates/setup/static_analysis_2.png" alt="A Static Analysis rule that fails when any code quality violations with an error status are contained in any service" style="width:100%" >}}

In the **Define rule conditions** section, select `code quality violations` from the dropdown menu. Then, select the `error` status type, select `above or equal to`, and enter the value of `1`.
In the **Define rule conditions** section, select `code quality violations` from the dropdown menu. Then, select the `error` status type, select `above or equal to`, and enter the value of `1`.

5. Specify a rule name that describes the rule that you are creating.
6. Select whether the rule should block the pipeline when it fails. Non-blocking rules are helpful when you roll out a new rule and want to verify its behavior before making it blocking.
Expand Down Expand Up @@ -112,7 +112,7 @@ After the permission is granted, you can see the checks in GitHub.

## Manage rules

You can edit and delete Quality Gates rules by hovering over a rule on the [**Quality Gates Rules** page][2].
You can edit and delete Quality Gates rules by hovering over a rule on the [**Quality Gates Rules** page][2].

{{< img src="quality_gates/setup/delete_2.png" alt="Edit, clone, or delete a Quality Gates rule" style="width:100%;">}}

Expand All @@ -131,7 +131,7 @@ For more information, see the [RBAC Permissions documentation][1].
[1]: /account_management/rbac/permissions
[2]: https://app.datadoghq.com/ci/quality-gates
[3]: /account_management/audit_trail/events/#ci-visibility-events
[4]: https://github.com/DataDog/datadog-ci/blob/master/packages/datadog-ci/src/commands/gate/README.md
[4]: https://github.com/DataDog/datadog-ci/blob/master/packages/plugin-gate/README.md
[5]: https://app.datadoghq.com/organization-settings/api-keys
[6]: https://app.datadoghq.com/organization-settings/application-keys
[7]: https://github.com/DataDog/datadog-ci/blob/master/README.md
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -157,9 +157,9 @@ datadog-ci flutter-symbols upload --service-name <your_service_name> --dart-symb
[2]: https://app.datadoghq.com/rum/application/create
[3]: https://docs.datadoghq.com/real_user_monitoring/mobile_and_tv_monitoring/flutter/setup
[4]: https://www.npmjs.com/package/@datadog/datadog-ci
[5]: https://github.com/DataDog/datadog-ci/tree/master/src/commands/flutter-symbols
[5]: https://github.com/DataDog/datadog-ci/tree/master/packages/datadog-ci/src/commands/flutter-symbols
[6]: https://pub.dev/documentation/datadog_flutter_plugin/latest/datadog_flutter_plugin/DatadogConfiguration-class.html
[7]: https://docs.flutter.dev/deployment/flavors
[8]: https://pub.dev/documentation/datadog_flutter_plugin/latest/datadog_flutter_plugin/DatadogConfiguration/flavor.html
[9]: https://pub.dev/documentation/datadog_flutter_plugin/latest/datadog_flutter_plugin/DatadogConfiguration/version.html
[10]: https://app.datadoghq.com/source-code/setup/rum
[10]: https://app.datadoghq.com/source-code/setup/rum
Original file line number Diff line number Diff line change
Expand Up @@ -499,7 +499,7 @@ Inside the loop, add the following snippet:
[9]: https://fastlane.tools/
[10]: https://appcenter.ms/
[11]: https://www.bitrise.io/
[12]: https://github.com/DataDog/datadog-ci/tree/master/src/commands/react-native#xcode
[12]: https://github.com/DataDog/datadog-ci/tree/master/packages/datadog-ci/src/commands/react-native#xcode
[13]: https://github.com/DataDog/datadog-react-native-wizard
[14]: https://github.com/DataDog/react-native-performance-limiter
[15]: https://plugins.gradle.org/plugin/com.datadoghq.dd-sdk-android-gradle-plugin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ If your front-end JavaScript source code is minified, upload your source maps to

## Instrument your code

Configure your JavaScript bundler such that when minifying your source code, it generates source maps that directly include the related source code in the `sourcesContent` attribute.
Configure your JavaScript bundler such that when minifying your source code, it generates source maps that directly include the related source code in the `sourcesContent` attribute.

<div class="alert alert-warning">
Ensure that the size of each source map augmented with the size of the related minified file does not exceed the limit of **500 MB**.
Expand Down Expand Up @@ -158,7 +158,7 @@ On the other hand, an unminified stack trace provides you with all the context y

{{< partial name="whats-next/whats-next.html" >}}

[1]: https://github.com/DataDog/datadog-ci/tree/master/src/commands/sourcemaps
[1]: https://github.com/DataDog/datadog-ci/tree/master/packages/datadog-ci/src/commands/sourcemaps
[2]: https://docs.datadoghq.com/real_user_monitoring/browser/setup/#initialization-parameters
[3]: https://docs.datadoghq.com/logs/log_collection/javascript/#initialization-parameters
[4]: https://github.com/DataDog/datadog-ci/tree/master/src/commands/sourcemaps#link-errors-with-your-source-code
[4]: https://github.com/DataDog/datadog-ci/tree/master/packages/datadog-ci/src/commands/sourcemaps#link-errors-with-your-source-code
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: "Enable comprehensive crash reporting and error tracking for Flutte

## Overview

Enable Crash Reporting and Error Tracking to get comprehensive crash reports and error trends with Real User Monitoring.
Enable Crash Reporting and Error Tracking to get comprehensive crash reports and error trends with Real User Monitoring.

Your crash reports appear in [**Error Tracking**][1].

Expand All @@ -32,7 +32,7 @@ final configuration = DdSdkConfiguration(
DatadogSdk.instance.initialize(configuration);
```

If your application suffers a fatal crash, once your application restarts, the Datadog Flutter SDK uploads a crash report to Datadog. For non-fatal errors, the Datadog Flutter SDK uploads these errors with other RUM data.
If your application suffers a fatal crash, once your application restarts, the Datadog Flutter SDK uploads a crash report to Datadog. For non-fatal errors, the Datadog Flutter SDK uploads these errors with other RUM data.


## Upload symbol files to Datadog
Expand All @@ -54,7 +54,7 @@ First, install the `datadog-ci` tool from the instructions above and create a `d

Because this file contains your API key, it should not be checked in to version control.

Alternately, you can set the `DATADOG_API_KEY` and `DATADOG_SITE` environment variables.
Alternately, you can set the `DATADOG_API_KEY` and `DATADOG_SITE` environment variables.

Then, you can use the following command to upload all the necessary files for symbolication and deobfuscation of your crash reports:
```sh
Expand Down Expand Up @@ -89,7 +89,7 @@ Note that Datadog uses tags for versions which do not allow `+`. All tooling aut
[2]: https://app.datadoghq.com/rum/application/create
[3]: https://docs.datadoghq.com/real_user_monitoring/flutter/#setup
[4]: https://www.npmjs.com/package/@datadog/datadog-ci
[6]: https://github.com/DataDog/datadog-ci/tree/master/src/commands/flutter-symbols
[6]: https://github.com/DataDog/datadog-ci/tree/master/packages/datadog-ci/src/commands/flutter-symbols
[7]: https://pub.dev/documentation/datadog_flutter_plugin/latest/datadog_flutter_plugin/DatadogConfiguration-class.html
[8]: https://docs.flutter.dev/deployment/flavors
[9]: https://pub.dev/documentation/datadog_flutter_plugin/latest/datadog_flutter_plugin/DatadogConfiguration/flavor.html
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -498,7 +498,7 @@ Inside the loop, add the following snippet:
[9]: https://fastlane.tools/
[10]: https://appcenter.ms/
[11]: https://www.bitrise.io/
[12]: https://github.com/DataDog/datadog-ci/tree/master/src/commands/react-native#xcode
[12]: https://github.com/DataDog/datadog-ci/tree/master/packages/datadog-ci/src/commands/react-native#xcode
[13]: https://github.com/DataDog/datadog-react-native-wizard
[14]: https://github.com/DataDog/react-native-performance-limiter
[15]: https://plugins.gradle.org/plugin/com.datadoghq.dd-sdk-android-gradle-plugin
Expand Down
Loading
Loading