From 8c63e2122cae298b4f04136ef52fda497b01a348 Mon Sep 17 00:00:00 2001
From: Alex Plischke <alex.plischke@saucelabs.com>
Date: Tue, 2 Apr 2024 16:40:43 -0700
Subject: [PATCH] docs: document saucectl tunnel timeout (#2713)

---
 docs/dev/cli/saucectl/run.md                  | 19 +++++++++++++++++++
 .../cucumberjs-playwright/yaml.md             | 15 +++++++++++++++
 .../automated-testing/cypress/yaml/v1.md      | 16 ++++++++++++++++
 .../automated-testing/playwright/yaml.md      | 15 +++++++++++++++
 .../web-apps/automated-testing/replay/yaml.md | 15 +++++++++++++++
 .../automated-testing/testcafe/yaml.md        | 15 +++++++++++++++
 6 files changed, 95 insertions(+)

diff --git a/docs/dev/cli/saucectl/run.md b/docs/dev/cli/saucectl/run.md
index 37cf5f2cda..801a90caf1 100644
--- a/docs/dev/cli/saucectl/run.md
+++ b/docs/dev/cli/saucectl/run.md
@@ -182,6 +182,11 @@ Execute tests according to the environment, framework, and test suite specificat
      <td></td>
      <td>The tunnel owner, if it is not the testing account.</td>
     </tr>
+    <tr>
+     <td><span className="t-cli"><a href="#--tunnel-timeout">--tunnel-timeout</a></span></td>
+     <td></td>
+     <td>How long to wait for the specified tunnel to be ready. Supports duration values like '10s', '30m' etc. (default: 30s)</td>
+    </tr>
     <tr>
      <td><span className="t-cli"><a href="#--upload-timeout">--upload-timeout</a></span></td>
      <td></td>
@@ -538,6 +543,7 @@ Toggles saucectl's own junit reporting on/off. This only affects the reports tha
 ```bash
 saucectl run --reporters.junit.enabled=true
 ```
+
 </div>
 
 ### <span className="cli">--reporters.junit.filename</span>
@@ -703,6 +709,19 @@ saucectl run --tunnel-name not-my-tunnel --tunnel-owner another.sauce.username
 
 </div>
 
+### <span className="cli">--tunnel-timeout</span>
+
+<div className="cli-desc">
+<p><small>| OPTIONAL | DURATION |</small></p>
+
+How long to wait for the specified tunnel to be ready. Supports duration values like '10s', '30m' etc. (default: 30s)
+
+```bash
+saucectl run --tunnel-name who-knows-when-ready --tunnel-timeout 1m
+```
+
+</div>
+
 ### <span className="cli">--verbose</span>
 
 <div className="cli-desc">
diff --git a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md
index f9ff152b63..1b18cdcd91 100644
--- a/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md
+++ b/docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md
@@ -254,6 +254,21 @@ sauce:
 
 ---
 
+#### `timeout`
+
+<p><small>| OPTIONAL | DURATION |</small></p>
+
+How long to wait for the specified tunnel to be ready. Supports duration values like '10s', '30m' etc. (default: 30s)
+
+```yaml
+sauce:
+  tunnel:
+    name: your_tunnel_name
+    timeout: 30s
+```
+
+---
+
 ### `visibility`
 
 <p><small>| OPTIONAL | STRING |</small></p>
diff --git a/docs/web-apps/automated-testing/cypress/yaml/v1.md b/docs/web-apps/automated-testing/cypress/yaml/v1.md
index 259a02a7ea..b6dddf42fe 100644
--- a/docs/web-apps/automated-testing/cypress/yaml/v1.md
+++ b/docs/web-apps/automated-testing/cypress/yaml/v1.md
@@ -215,6 +215,7 @@ sauce:
   tunnel:
     name: your_tunnel_name
     owner: tunnel_owner_username
+    timeout: 30s
 ```
 
 :::caution
@@ -260,6 +261,21 @@ sauce:
 
 ---
 
+#### `timeout`
+
+<p><small>| OPTIONAL | DURATION |</small></p>
+
+How long to wait for the specified tunnel to be ready. Supports duration values like '10s', '30m' etc. (default: 30s)
+
+```yaml
+sauce:
+  tunnel:
+    name: your_tunnel_name
+    timeout: 30s
+```
+
+---
+
 ### `visibility`
 
 <p><small>| OPTIONAL | STRING |</small></p>
diff --git a/docs/web-apps/automated-testing/playwright/yaml.md b/docs/web-apps/automated-testing/playwright/yaml.md
index 7075836ee0..64e8c2bd3d 100644
--- a/docs/web-apps/automated-testing/playwright/yaml.md
+++ b/docs/web-apps/automated-testing/playwright/yaml.md
@@ -248,6 +248,21 @@ sauce:
 
 ---
 
+#### `timeout`
+
+<p><small>| OPTIONAL | DURATION |</small></p>
+
+How long to wait for the specified tunnel to be ready. Supports duration values like '10s', '30m' etc. (default: 30s)
+
+```yaml
+sauce:
+  tunnel:
+    name: your_tunnel_name
+    timeout: 30s
+```
+
+---
+
 ### `visibility`
 
 <p><small>| OPTIONAL | STRING |</small></p>
diff --git a/docs/web-apps/automated-testing/replay/yaml.md b/docs/web-apps/automated-testing/replay/yaml.md
index f06bbafdeb..685e3503ec 100644
--- a/docs/web-apps/automated-testing/replay/yaml.md
+++ b/docs/web-apps/automated-testing/replay/yaml.md
@@ -248,6 +248,21 @@ sauce:
 
 ---
 
+#### `timeout`
+
+<p><small>| OPTIONAL | DURATION |</small></p>
+
+How long to wait for the specified tunnel to be ready. Supports duration values like '10s', '30m' etc. (default: 30s)
+
+```yaml
+sauce:
+  tunnel:
+    name: your_tunnel_name
+    timeout: 30s
+```
+
+---
+
 ### `visibility`
 
 <p><small>| OPTIONAL | STRING |</small></p>
diff --git a/docs/web-apps/automated-testing/testcafe/yaml.md b/docs/web-apps/automated-testing/testcafe/yaml.md
index f388de65d5..e5da868150 100644
--- a/docs/web-apps/automated-testing/testcafe/yaml.md
+++ b/docs/web-apps/automated-testing/testcafe/yaml.md
@@ -248,6 +248,21 @@ sauce:
 
 ---
 
+#### `timeout`
+
+<p><small>| OPTIONAL | DURATION |</small></p>
+
+How long to wait for the specified tunnel to be ready. Supports duration values like '10s', '30m' etc. (default: 30s)
+
+```yaml
+sauce:
+  tunnel:
+    name: your_tunnel_name
+    timeout: 30s
+```
+
+---
+
 ### `visibility`
 
 <p><small>| OPTIONAL | STRING |</small></p>