Skip to content

Commit

Permalink
Minor documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
nikita-tkachenko-datadog committed Jan 4, 2024
1 parent fa17562 commit c355141
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -230,14 +230,14 @@ From a job specific configuration page:

### Test Visibility Configuration

The plugin can automatically configure Datadog <a target="_blank" href="https://docs.datadoghq.com/continuous_integration/tests/">Test Visibility</a> for a job or a pipeline.
The plugin can automatically configure Datadog [Test Visibility][19] for a job or a pipeline (see the Test Visibility [documentation for your language][20] to make sure that the testing framework that you use is supported).

Before enabling Test Visibility, be sure to properly configure the plugin to submit data to Datadog.

There are two options to enable automatic Test Visibility configuration:

1. Using Jenkins UI: go to the `Configure` page of the job or pipeline whose tests need to be traced, tick `Enable Datadog Test Visibility` checkbox in the `General` section and save your changes. This option is unavailable if you are using Multibranch Pipelines, Organization Folders, or other types of pipelines that are configured entirely with `Jenkinsfile`.
2. Using `datadog` pipeline step:
1. Using Jenkins UI (available in the plugin v5.6.0 or newer): go to the `Configure` page of the job or pipeline whose tests need to be traced, tick `Enable Datadog Test Visibility` checkbox in the `General` section and save your changes. This option is unavailable if you are using Multibranch Pipelines, Organization Folders, or other types of pipelines that are configured entirely with `Jenkinsfile`.
2. Using `datadog` pipeline step (available in the plugin v5.6.2 or newer):

In declarative pipelines, add the step to a top-level `options` block like so:

Expand Down Expand Up @@ -457,3 +457,5 @@ Checkout the [development document][12] for tips on spinning up a quick developm
[16]: https://raw.githubusercontent.com/jenkinsci/datadog-plugin/master/images/dashboard.png
[17]: https://docs.datadoghq.com/developers/dogstatsd/?tab=containeragent#
[18]: https://www.jenkins.io/doc/book/using/using-credentials/
[19]: https://docs.datadoghq.com/tests/
[20]: https://docs.datadoghq.com/tests/setup/

0 comments on commit c355141

Please sign in to comment.