Skip to content

Commit

Permalink
Merge pull request #264 from DataDog/teodor.todorov/SYNTH-12977/reord…
Browse files Browse the repository at this point in the history 
…er-properties

[SYNTH-12977] Reorder properties
  • Loading branch information
@teodor2312
teodor2312 authored Aug 5, 2024
2 parents 3895ef8 + 2a7937d commit f54d9ba
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 28 deletions.
18 changes: 9 additions & 9 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -121,19 +121,19 @@ For an example of a global configuration file, see this [`global.config.json` fi
| ------------------------- | ------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `api_key` | string | _required_ | Your Datadog API key. This key is created by your [Datadog organization][2] and should be stored as a [secret][3]. **Default:** none. |
| `app_key` | string | _required_ | Your Datadog Application key. This key is created by your [Datadog organization][2] and should be stored as a [secret][3]. **Default:** none. |
| `public_ids` | string | _optional_ | Comma-separated list of public IDs for Synthetic tests you want to trigger. If no value is provided, the action looks for files named with `synthetics.json`. **Default:** none. |
| `test_search_query` | string | _optional_ | Trigger tests corresponding to a [search query][5]. **Default:** none. |
| `subdomain` | string | _optional_ | The name of the custom subdomain set to access your Datadog application. If the URL used to access Datadog is `myorg.datadoghq.com`, the subdomain value needs to be set to `myorg`. **Default:** `app`. |
| `files` | string | _optional_ | Glob pattern to detect Synthetic test configuration files. **Default:** `{,!(node_modules)/**/}*.synthetics.json`. |
| `datadog_site` | string | _optional_ | The [Datadog site][11] to send data to. **Default:** `datadoghq.com`. |
| `config_path` | string | _optional_ | The [global JSON configuration][4] to be used when launching tests. See the [example configuration file][13] for more details. **Default:** `datadog-ci.json`. |
| `variables` | string | _optional_ | Comma-separated list of global variables to use for Synthetic tests. For example: `START_URL=https://example.org,MY_VARIABLE=My title`. **Default:** `[]`. |
| `junit_report` | string | _optional_ | The filename for a JUnit report if you want to generate one. **Default:** none. |
| `tunnel` | boolean | _optional_ | Use the [Continuous Testing Tunnel][9] to execute your test batch. **Default:** `false`. |
| `polling_timeout` | number | _optional_ | The duration (in milliseconds) after which the action stops polling for test results. At the CI level, test results completed after this duration are considered failed. **Default:** 30 minutes. |
| `datadog_site` | string | _optional_ | The [Datadog site][11] to send data to. **Default:** `datadoghq.com`. |
| `fail_on_critical_errors` | boolean | _optional_ | Fail the CI job if no tests were triggered, or results could not be fetched from Datadog. **Default:** `false`. |
| `fail_on_missing_tests` | boolean | _optional_ | Fail the CI job if at least one specified test with a public ID (using `public_ids` or listed in a [test file][12]) is missing in a run (for example, if it has been deleted programmatically or on the Datadog site). **Default:** `false`. |
| `fail_on_timeout` | boolean | _optional_ | Fail the CI job if at least one test exceeds the default test timeout. **Default:** `true`. |
| `files` | string | _optional_ | Glob pattern to detect Synthetic test configuration files. **Default:** `{,!(node_modules)/**/}*.synthetics.json`. |
| `junit_report` | string | _optional_ | The filename for a JUnit report if you want to generate one. **Default:** none. |
| `public_ids` | string | _optional_ | Comma-separated list of public IDs for Synthetic tests you want to trigger. If no value is provided, the action looks for files named with `synthetics.json`. **Default:** none. |
| `polling_timeout` | number | _optional_ | The duration (in milliseconds) after which the action stops polling for test results. At the CI level, test results completed after this duration are considered failed. **Default:** 30 minutes. |
| `subdomain` | string | _optional_ | The name of the custom subdomain set to access your Datadog application. If the URL used to access Datadog is `myorg.datadoghq.com`, the subdomain value needs to be set to `myorg`. **Default:** `app`. |
| `test_search_query` | string | _optional_ | Trigger tests corresponding to a [search query][5]. **Default:** none. |
| `tunnel` | boolean | _optional_ | Use the [Continuous Testing Tunnel][9] to execute your test batch. **Default:** `false`. |
| `variables` | string | _optional_ | Comma-separated list of global variables to use for Synthetic tests. For example: `START_URL=https://example.org,MY_VARIABLE=My title`. **Default:** `[]`. |

## Contributing

Expand Down
38 changes: 19 additions & 19 deletions action.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,33 @@ inputs:
app_key:
required: true
description: 'Datadog Application key.'
config_path:
required: false
description: 'Path to global configuration JSON.'
datadog_site:
required: false
description: 'Datadog site.'
public_ids:
fail_on_critical_errors:
required: false
description: 'Public IDs of Synthetic tests to run.'
config_path:
description: 'Fail the CI job if no tests were triggered, or results could not be fetched from Datadog.'
fail_on_missing_tests:
required: false
description: 'Path to global configuration JSON.'
description: 'Fail the CI job if at least one specified test with a public ID (using `public_ids` or listed in a test file) is missing in a run (for example, if it has been deleted programmatically or on the Datadog site).'
fail_on_timeout:
required: false
description: 'Fail the CI job if at least one test exceeds the default test timeout.'
files:
required: false
description: 'Glob pattern to detect Synthetic tests config.'
junit_report:
required: false
description: 'The filename for a JUnit report if you want to generate one.'
polling_timeout:
required: false
description: 'The duration (in milliseconds) after which the action stops polling for test results.'
public_ids:
required: false
description: 'Public IDs of Synthetic tests to run.'
subdomain:
required: false
description: 'Name of your Datadog custom subdomain.'
Expand All @@ -33,21 +48,6 @@ inputs:
variables:
required: false
description: 'Comma-separated list of variable_name=variable_value pairs.'
junit_report:
required: false
description: 'The filename for a JUnit report if you want to generate one.'
polling_timeout:
required: false
description: 'The duration (in milliseconds) after which the action stops polling for test results.'
fail_on_critical_errors:
required: false
description: 'Fail the CI job if no tests were triggered, or results could not be fetched from Datadog.'
fail_on_missing_tests:
required: false
description: 'Fail the CI job if at least one specified test with a public ID (using `public_ids` or listed in a test file) is missing in a run (for example, if it has been deleted programmatically or on the Datadog site).'
fail_on_timeout:
required: false
description: 'Fail the CI job if at least one test exceeds the default test timeout.'

runs:
using: 'node20'
Expand Down

0 comments on commit f54d9ba

Please sign in to comment.