Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moved Two Capabilities Under New Section To Properly Align with what They Support #3044

Merged
merged 1 commit into from
Dec 13, 2024
+32 −32
Merged

Moved Two Capabilities Under New Section To Properly Align with what They Support #3044

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 32 additions & 32 deletions docs/dev/test-configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1970,38 +1970,6 @@

---

### `recordVideo`

<p><small>| OPTIONAL | BOOLEAN |</small></p>

Use this to disable video recording. By default, Sauce Labs records a video of every test you run. Disabling video recording can be useful for debugging failing tests as well as having a visual confirmation that a certain feature works (or still works). However, there is an added wait time for screen recording during a test run.

```java
MutableCapabilities capabilities = new MutableCapabilities();
//...
MutableCapabilities sauceOptions = new MutableCapabilities();
sauceOptions.setCapability("recordVideo", false);
capabilities.setCapability("sauce:options", sauceOptions);
```

---

### `videoUploadOnPass`

<p><small>| OPTIONAL | BOOLEAN |</small></p>

Disables video upload for passing tests. `videoUploadOnPass` is an alternative to `recordVideo`; it lets you discard videos for tests you've marked as passing. It disables video post-processing and uploading that may otherwise consume some extra time after your test is complete.

```java
MutableCapabilities capabilities = new MutableCapabilities();
//...
MutableCapabilities sauceOptions = new MutableCapabilities();
sauceOptions.setCapability("videoUploadOnPass", false);
capabilities.setCapability("sauce:options", sauceOptions);
```

---

### `recordScreenshots`

<p><small>| OPTIONAL | BOOLEAN |</small></p>
Expand Down Expand Up @@ -2103,6 +2071,22 @@

---

### `recordVideo`

<p><small>| OPTIONAL | BOOLEAN |</small></p>

Use this to disable video recording. By default, Sauce Labs records a video of every test you run. Disabling video recording can be useful for debugging failing tests as well as having a visual confirmation that a certain feature works (or still works). However, there is an added wait time for screen recording during a test run.

Check warning on line 2078 in docs/dev/test-configuration-options.md

View workflow job for this annotation

GitHub Actions / vale 

[vale] reported by reviewdog 🐶
[sauce.Simplicity] Remove 'useful'. Be precise instead of subjective.

Raw Output:
{"message": "[sauce.Simplicity] Remove 'useful'. Be precise instead of subjective.", "location": {"path": "docs/dev/test-configuration-options.md", "range": {"start": {"line": 2078, "column": 133}}}, "severity": "WARNING"}

```java
MutableCapabilities capabilities = new MutableCapabilities();
//...
MutableCapabilities sauceOptions = new MutableCapabilities();
sauceOptions.setCapability("recordVideo", false);
capabilities.setCapability("sauce:options", sauceOptions);
```

---

### `timeZone`

<p><small>| OPTIONAL | STRING | <span className="sauceGreen">Desktop and Virtual Devices Only</span> |</small></p>
Expand Down Expand Up @@ -2150,6 +2134,22 @@

---

### `videoUploadOnPass`

<p><small>| OPTIONAL | BOOLEAN |</small></p>

Disables video upload for passing tests. `videoUploadOnPass` is an alternative to `recordVideo`; it lets you discard videos for tests you've marked as passing. It disables video post-processing and uploading that may otherwise consume some extra time after your test is complete.

```java
MutableCapabilities capabilities = new MutableCapabilities();
//...
MutableCapabilities sauceOptions = new MutableCapabilities();
sauceOptions.setCapability("videoUploadOnPass", false);
capabilities.setCapability("sauce:options", sauceOptions);
```

---

### Pre-Run Executables

<p><small>| OPTIONAL | <span className="sauceGreen">Desktop and Virtual Devices Only</span> |</small></p>
Expand Down
Loading