From 66ead356f42853ee40ece53b601d678c2388267c Mon Sep 17 00:00:00 2001 From: Tian Feng Date: Mon, 25 Nov 2024 14:58:17 -0800 Subject: [PATCH 1/4] docs: revise Cucumber format option --- .../cucumberjs-playwright/yaml.md | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md index 3d375d70c3..0dd0a3c4e4 100644 --- a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md +++ b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md @@ -423,7 +423,7 @@ npm: auth: base64SecretToken username: myUsername password: myPassword - email: myEmail + email: myEmail ``` --- @@ -743,7 +743,7 @@ artifacts:

| OPTIONAL | OBJECT |

Define directories to archive and retain as a test asset at the end of a test run. Archived test assets can -be downloaded automatically using the `download` configuration, via the +be downloaded automatically using the `download` configuration, via the [REST API](/dev/api/jobs/#get-a-job-asset-file), or through the test details page. ```yaml @@ -1125,7 +1125,7 @@ suites: require: - "features/support/*.js" format: - - "json:my-cucumber.json" + - '"json":"my-cucumber.json"' ``` --- @@ -1259,14 +1259,23 @@ suites:

| OPTIONAL | ARRAY |

-Name/path and (optionally) output file path of each formatter to use. See the [Cucumber.js Formatters documentation](https://github.com/cucumber/cucumber-js/blob/main/docs/formatters.md) for more information. +Specifies the name or path of each formatter to use, along with an optional output file path. If no output file path is specified, the output defaults to stdout. +The name or path, as well as the optional output file path, must be enclosed in quotes. See the [Cucumber.js Formatters documentation](https://github.com/cucumber/cucumber-js/blob/main/docs/formatters.md) for more information. + +:::warning +Cucumber deprecated the previous `format` configuration in version **9.6.0** and will remove it in **11.0.0** or later. +If you're still using a `format` setting without quotes, please migrate to the latest pattern. +For more details, see the [Cucumber.js Deprecations documentation](https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md#ambiguous-colons-in-formats). + +The `file://my_formatter/implementation:output_file` is an example of ambiguous colon usage and is not allowed in Sauce Labs now. Please migrate to the quoted pattern. +::: ```yaml suites: - name: My Cucumber Test options: format: - - "json:my-cucumber.json" + - '"json":"my-cucumber.json"' ``` --- From 5fa88be18a8774ee810e42d41c65eebe70d5632e Mon Sep 17 00:00:00 2001 From: Tian Feng Date: Mon, 25 Nov 2024 15:02:38 -0800 Subject: [PATCH 2/4] =?UTF-8?q?no=20please=20=CE=A3(=EF=BE=9F=E5=8F=A3?= =?UTF-8?q?=EF=BE=9F;)//?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md index 0dd0a3c4e4..50a28dd361 100644 --- a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md +++ b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md @@ -1264,10 +1264,10 @@ The name or path, as well as the optional output file path, must be enclosed in :::warning Cucumber deprecated the previous `format` configuration in version **9.6.0** and will remove it in **11.0.0** or later. -If you're still using a `format` setting without quotes, please migrate to the latest pattern. +If you're still using a `format` setting without quotes, migrate to the latest pattern. For more details, see the [Cucumber.js Deprecations documentation](https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md#ambiguous-colons-in-formats). -The `file://my_formatter/implementation:output_file` is an example of ambiguous colon usage and is not allowed in Sauce Labs now. Please migrate to the quoted pattern. +The `file://my_formatter/implementation:output_file` is an example of ambiguous colon usage and is not allowed in Sauce Labs now. You should migrate to the quoted pattern. ::: ```yaml From 2efabf76acf7d22c160f7c241c2cd07642a51d37 Mon Sep 17 00:00:00 2001 From: Tian Feng Date: Mon, 25 Nov 2024 15:07:33 -0800 Subject: [PATCH 3/4] revise docs --- docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md index 50a28dd361..d2d813e464 100644 --- a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md +++ b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md @@ -1263,7 +1263,7 @@ Specifies the name or path of each formatter to use, along with an optional outp The name or path, as well as the optional output file path, must be enclosed in quotes. See the [Cucumber.js Formatters documentation](https://github.com/cucumber/cucumber-js/blob/main/docs/formatters.md) for more information. :::warning -Cucumber deprecated the previous `format` configuration in version **9.6.0** and will remove it in **11.0.0** or later. +Cucumber deprecated the previous `format` configuration without quotes in version **9.6.0** and will remove it in **11.0.0** or later. If you're still using a `format` setting without quotes, migrate to the latest pattern. For more details, see the [Cucumber.js Deprecations documentation](https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md#ambiguous-colons-in-formats). From 8686a86d0d6347ef1d1514fd0e50218820791eeb Mon Sep 17 00:00:00 2001 From: Tian Feng Date: Mon, 25 Nov 2024 16:06:58 -0800 Subject: [PATCH 4/4] simplify docs --- docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md index d2d813e464..9a32635505 100644 --- a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md +++ b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md @@ -1266,8 +1266,6 @@ The name or path, as well as the optional output file path, must be enclosed in Cucumber deprecated the previous `format` configuration without quotes in version **9.6.0** and will remove it in **11.0.0** or later. If you're still using a `format` setting without quotes, migrate to the latest pattern. For more details, see the [Cucumber.js Deprecations documentation](https://github.com/cucumber/cucumber-js/blob/main/docs/deprecations.md#ambiguous-colons-in-formats). - -The `file://my_formatter/implementation:output_file` is an example of ambiguous colon usage and is not allowed in Sauce Labs now. You should migrate to the quoted pattern. ::: ```yaml