diff --git a/content/en/continuous_delivery/deployments/ciproviders.md b/content/en/continuous_delivery/deployments/ciproviders.md index 6fa62c4ea27cc..36340dd2fd930 100644 --- a/content/en/continuous_delivery/deployments/ciproviders.md +++ b/content/en/continuous_delivery/deployments/ciproviders.md @@ -91,9 +91,14 @@ datadog-ci deployment mark --env prod --tags team:backend --tags reason:schedule ## Mark GitHub Actions jobs as deployments -To mark GitHub jobs as deployments, `datadog-ci CLI` version `2.29.0` or higher is required. -If the job name does not match the entry defined in the workflow configuration file (the GitHub [job ID][12]), -the `DD_GITHUB_JOB_NAME` environment variable needs to be exposed, pointing to the job name. For example: + +Starting with `datadog-ci` version `4.1.1`, no additional action is required, even when using custom names or matrix strategies. + +
+For datadog-ci versions prior to 4.1.1 + +If you are using `datadog-ci` version `2.29.0` to `4.1.0` and the job name does not match the entry defined in the workflow configuration file (the GitHub [job ID][12]), the `DD_GITHUB_JOB_NAME` environment variable needs to be exposed, pointing to the job name. For example: + 1. If the job name is changed using the [name property][13]: ```yaml jobs: @@ -118,6 +123,7 @@ the `DD_GITHUB_JOB_NAME` environment variable needs to be exposed, pointing to t steps: - run: datadog-ci deployment mark ... ``` +
## Further reading diff --git a/content/en/continuous_integration/pipelines/custom_commands.md b/content/en/continuous_integration/pipelines/custom_commands.md index 1b888e9c449cf..71a773eaeebf4 100644 --- a/content/en/continuous_integration/pipelines/custom_commands.md +++ b/content/en/continuous_integration/pipelines/custom_commands.md @@ -181,8 +181,14 @@ Additionally, configure the Datadog site to use the selected one ({{< region-par ## Known issue with GitHub Actions -If the job name does not match the entry defined in the workflow configuration file (the GitHub [job ID][3]), -the `DD_GITHUB_JOB_NAME` environment variable needs to be exposed, pointing to the job name. For example: + +Starting with `datadog-ci` version `4.1.1`, no additional action is required, even when using custom names or matrix strategies. + +
+For datadog-ci versions prior to 4.1.1 + +If you are using `datadog-ci` version `2.29.0` to `4.1.0` and the job name does not match the entry defined in the workflow configuration file (the GitHub [job ID][3]), the `DD_GITHUB_JOB_NAME` environment variable needs to be exposed, pointing to the job name. For example: + 1. If the job name is changed using the [name property][4]: ```yaml jobs: @@ -207,6 +213,7 @@ the `DD_GITHUB_JOB_NAME` environment variable needs to be exposed, pointing to t steps: - run: datadog-ci trace ... ``` +
## Troubleshooting diff --git a/content/en/continuous_integration/pipelines/custom_tags_and_measures.md b/content/en/continuous_integration/pipelines/custom_tags_and_measures.md index a349164c1e4a0..849ec9731e97b 100644 --- a/content/en/continuous_integration/pipelines/custom_tags_and_measures.md +++ b/content/en/continuous_integration/pipelines/custom_tags_and_measures.md @@ -14,7 +14,7 @@ further_reading: ## Overview -Use the custom tags and measures commands to add user-defined text and numerical tags to your pipeline traces in [CI Pipeline Visibility][11]. You can use the [`datadog-ci` NPM package][1] to add custom tags to a pipeline trace or a job span, in addition to adding measures to a pipeline trace or a job span. From these custom tags and measures, you can create facets (string value tags) or measures (numerical value tags). +Use the custom tags and measures commands to add user-defined text and numerical tags to your pipeline traces in [CI Pipeline Visibility][11]. You can use the [`datadog-ci` NPM package][1] to add custom tags to a pipeline trace or a job span, in addition to adding measures to a pipeline trace or a job span. From these custom tags and measures, you can create facets (string value tags) or measures (numerical value tags). You can use facets and measures to filter, create visualizations, or create monitors for your pipelines in the [CI Visibility Explorer][10]. @@ -67,7 +67,7 @@ Invoke-WebRequest -Uri "https://github.com/DataDog/datadog-ci/releases/latest/do ## Add tags to pipeline traces -Tags can be added to the pipeline span or to the job span. +Tags can be added to the pipeline span or to the job span. To do this, run the `tag` command: @@ -119,9 +119,14 @@ To create a measure, click the gear icon next to a measures name on the [Pipelin ## Add tags and measures to GitHub jobs -To add tags and measures to GitHub jobs, `datadog-ci CLI` version `2.29.0` or higher is required. -If the job name does not match the entry defined in the workflow configuration file (the GitHub [job ID][7]), -the `DD_GITHUB_JOB_NAME` environment variable needs to be exposed, pointing to the job name. For example: + +Starting with `datadog-ci` version `4.1.1`, no additional action is required, even when using custom names or matrix strategies. + +
+For datadog-ci versions prior to 4.1.1 + +If you are using `datadog-ci` version `2.29.0` to `4.1.0` and the job name does not match the entry defined in the workflow configuration file (the GitHub [job ID][7]), the `DD_GITHUB_JOB_NAME` environment variable needs to be exposed, pointing to the job name. For example: + 1. If the job name is changed using the [name property][8]: ```yaml jobs: @@ -146,7 +151,8 @@ the `DD_GITHUB_JOB_NAME` environment variable needs to be exposed, pointing to t steps: - run: datadog-ci tag ... ``` - +
+ ## Limitations - The maximum amount of tags that can be added to a pipeline or job is 100.