Skip to content

Commit

Permalink
docs: document saucectl tunnel timeout (#2713)
Browse files Browse the repository at this point in the history
  • Loading branch information
Alex Plischke authored Apr 2, 2024
1 parent be677d3 commit 8c63e21
Show file tree
Hide file tree
Showing 6 changed files with 95 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/dev/cli/saucectl/run.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down Expand Up @@ -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>
Expand Down Expand Up @@ -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">
Expand Down
15 changes: 15 additions & 0 deletions docs/web-apps/automated-testing/cucumberjs-playwright/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
16 changes: 16 additions & 0 deletions docs/web-apps/automated-testing/cypress/yaml/v1.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,7 @@ sauce:
tunnel:
name: your_tunnel_name
owner: tunnel_owner_username
timeout: 30s
```

:::caution
Expand Down Expand Up @@ -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>
Expand Down
15 changes: 15 additions & 0 deletions docs/web-apps/automated-testing/playwright/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
15 changes: 15 additions & 0 deletions docs/web-apps/automated-testing/replay/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
15 changes: 15 additions & 0 deletions docs/web-apps/automated-testing/testcafe/yaml.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down

0 comments on commit 8c63e21

Please sign in to comment.