Skip to content

Commit 3dd9e3c

Browse files
author
Kerem Beygo
committed
Env vars for all sdks
1 parent a0aebb5 commit 3dd9e3c

File tree

5 files changed

+27
-2
lines changed

5 files changed

+27
-2
lines changed

docs/visual-testing/_partials/_environment-variables.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
| `SAUCE_USERNAME` | required | Your Sauce Labs username. You can get this from the header of app.saucelabs.com |
44
| `SAUCE_ACCESS_KEY` | required | Your Sauce Labs access key. You can get this from the header of app.saucelabs.com |
55
| `SAUCE_REGION` | | The region you'd like to run your Visual tests in. Defaults to `us-west-1` if not supplied. Can be one of the following: <br/> `'eu-central-1'`, `'us-west-1'` or `'us-east-4'` |
6-
| `SAUCE_BUILD_NAME` | | The name you would like to appear in the Sauce Visual dashboard. Defaults to 'Storybook Build' |
6+
| `SAUCE_BUILD_NAME` | | The name you would like to appear in the Sauce Visual dashboard. |
77
| `SAUCE_VISUAL_BRANCH` | | The branch name you would like to associate this build with. We recommend using your current VCS branch in CI. |
88
| `SAUCE_VISUAL_DEFAULT_BRANCH` | | The main branch name you would like to associate this build with. Usually `main` or `master` or alternatively the branch name your current branch was derived from. [Follow me to learn more](../workflows/ci.md) |
99
| `SAUCE_VISUAL_PROJECT` | | The label / project you would like to associated this build with. |

docs/visual-testing/integrations/csharp.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -242,9 +242,15 @@ Remember, the baseline is established during the initial run, and any subsequent
242242

243243
## Advanced usage
244244

245+
### Customizing Your Builds (Environment Variables)
246+
247+
Below are the environment variables available in the Sauce Visual C# plugin:
248+
249+
<EnvironmentVariables />
250+
245251
### Test results summary
246252

247-
`VisualClient.VisualResults()` returns a summary of test results in `Dictionnary<DiffStatus, int>` format where `DiffStatus` is one of the following:
253+
`VisualClient.VisualResults()` returns a summary of test results in `Dictionary<DiffStatus, int>` format where `DiffStatus` is one of the following:
248254

249255
- `DiffStatus.QUEUED`: Diffs that are pending for processing. Should be 0 in case the test is completed without any timeouts
250256
- `DiffStatus.EQUAL`: Diffs that have no changes detected

docs/visual-testing/integrations/java.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,12 @@ Remember, the baseline is established during the initial run, and any subsequent
222222

223223
## Advanced usage
224224

225+
### Customizing Your Builds (Environment Variables)
226+
227+
Below are the environment variables available in the Sauce Visual Java plugin:
228+
229+
<EnvironmentVariables />
230+
225231
### Test results summary
226232

227233
`VisualApi#sauceVisualResults()` returns a summary of test results in `Map<DiffStatus, Integer>` format where `DiffStatus` is one of the following:

docs/visual-testing/integrations/nightwatch.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,12 @@ More information about the status can be found [here](#sauce-visual-assertion)
167167

168168
## Advanced usage
169169

170+
### Customizing Your Builds (Environment Variables)
171+
172+
Below are the environment variables available in the Sauce Visual Nightwatch plugin:
173+
174+
<EnvironmentVariables />
175+
170176
### Sauce Visual Assertion
171177

172178
:::note

docs/visual-testing/integrations/webdriverio.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,8 +99,15 @@ Upon executing your tests for the first time under this step, a visual baseline
9999

100100
Remember, the baseline is established during the initial run, and any subsequent visual differences detected will be marked for review.
101101

102+
102103
## Advanced usage
103104

105+
### Customizing Your Builds (Environment Variables)
106+
107+
Below are the environment variables available in the Sauce Visual WebdriverIO plugin:
108+
109+
<EnvironmentVariables />
110+
104111
### Test results summary
105112

106113
`browser.sauceVisualResults()` returns a summary of test results in format:

0 commit comments

Comments
 (0)