Skip to content

Commit

Permalink
Merge pull request #2657 from saucelabs/sauce-visual-custom-id
Browse files Browse the repository at this point in the history
sauce visual custom id
  • Loading branch information
kb-kerem authored Feb 29, 2024
2 parents e879962 + 6a896a4 commit cf6f07d
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 1 deletion.
15 changes: 15 additions & 0 deletions docs/visual-testing/integrations/cypress.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,21 @@ export default defineConfig({
}
```

### Environment variables

Below are the environment variables available for the Sauce Visual for Cypress plugin. Keep in mind that these variables have precedence over the ones defined in Cypress configuration.

| Variable Name | | Description |
| ----------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `SAUCE_USERNAME` | required | Your Sauce Labs username. You can get this from the header of app.saucelabs.com |
| `SAUCE_ACCESS_KEY` | required | Your Sauce Labs access key. You can get this from the header of app.saucelabs.com |
| `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'` |
| `SAUCE_VISUAL_BUILD_NAME` | | The name you would like to appear in the Sauce Visual dashboard. Defaults to 'Cypress Visual Testing' |
| `SAUCE_VISUAL_BRANCH_NAME` | | The branch name or tag you would like to associate this build with. We recommend using your current VCS branch in CI. |
| `SAUCE_VISUAL_PROJECT_NAME` | | The label / project you would like to associate this build with. |
| `SAUCE_VISUAL_BUILD_ID` | | For advanced users, a user-supplied SauceLabs Visual build ID. Can be used to create builds in advance using the GraphQL API. This can be used to parallelize tests with multiple browsers, shard, or more. <br/> By default, this is not set and we create / finish a build during setup / teardown. |
| `SAUCE_VISUAL_CUSTOM_ID` | | For advanced users, a user-supplied custom ID to identify this build. Can be used in CI to identify / check / re-check the status of a single build. Usage suggestions: CI pipeline ID. |

### Ignored regions

#### Component-based ignored region
Expand Down
3 changes: 2 additions & 1 deletion docs/visual-testing/integrations/storybook.md
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,8 @@ Below are the environment variables available in the visual-storybook plugin:
| `SAUCE_BUILD_NAME` | | The name you would like to appear in the Sauce Visual dashboard. Defaults to 'Storybook Build' |
| `SAUCE_BRANCH_NAME` | | The branch name or tag you would like to associate this build with. We recommend using your current VCS branch in CI. |
| `SAUCE_PROJECT_NAME` | | The label / project you would like to associated this build with. |
| `SAUCE_VISUAL_BUILD_ID` | | For advanced users, a custom build ID. Can be used to create builds in advance. This can be used to parallelize tests, shard, or more. <br/> By default, this is not set and we create / finish a build during setup / teardown. |
| `SAUCE_VISUAL_BUILD_ID` | | For advanced users, a user-supplied SauceLabs Visual build ID. Can be used to create builds in advance using the GraphQL API. This can be used to parallelize tests with multiple browsers, shard, or more. <br/> By default, this is not set and we create / finish a build during setup / teardown. |
| `SAUCE_VISUAL_CUSTOM_ID` | | For advanced users, a user-supplied custom ID to identify this build. Can be used in CI to identify / check / re-check the status of a single build. Usage suggestions: CI pipeline ID. |

## Story / Global Configuration

Expand Down

0 comments on commit cf6f07d

Please sign in to comment.