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

Document how to use the Sauce plugin #440

Merged
merged 1 commit into from
Jun 6, 2018
Merged

Document how to use the Sauce plugin #440

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
23 changes: 17 additions & 6 deletions packages/web-component-tester/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,11 +214,27 @@ Note that by specifying a plugin's configuration, you are letting WCT know that
it should load that plugin. If you wish to provide default configuration for a
plugin, but not enable it, you can have it default to disabled:

Requesting that plugin via `--plugin` on the command line (or overriding the
plugin's configuration to `disabled: false`) will cause the plugin to kick in.

### Sauce

The **sauce** plugin runs your tests on [Sauce](https://saucelabs.com/).

To use the sauce plugin you need to include credentials. To do this, either
set the `SAUCE_USERNAME` and `SAUCE_ACCESS_KEY` environment variables, or
set the `username` and `accessKey` fields in the `plugins.sauce` section of
your `wct.conf.json`.

You can configure the browsers that Sauce will run by setting the `browsers`
array in the plugin configuration. The options are the same as the ones documented
on the Sauce Wiki [here](https://wiki.saucelabs.com/display/DOCS/Test+Configuration+Options#TestConfigurationOptions-RequiredSeleniumTestConfigurationSettings).
For example:

```js
{
"plugins": {
"sauce": {
"disabled": true,
"browsers": [{
"browserName": "microsoftedge",
"platform": "Windows 10",
Expand All @@ -239,11 +255,6 @@ plugin, but not enable it, you can have it default to disabled:
}
```

For more information on Sauce configuration, [see their Wiki](https://wiki.saucelabs.com/display/DOCS/Test+Configuration+Options#TestConfigurationOptions-RequiredSeleniumTestConfigurationSettings)

Requesting that plugin via `--plugin` on the command line (or overriding the
plugin's configuration to `disabled: false`) will cause the plugin to kick in.

## Variant dependencies

Sometimes you want to run your project's tests against different versions of
Expand Down