Skip to content

Commit 70c0f3a

Browse files
committed
feat: new release
update docs
1 parent 41994f0 commit 70c0f3a

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

README.md

Lines changed: 21 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ npm install karma-sauce-launcher --save-dev
2424

2525
This launcher is typically used in CI to run your unit tests across many browsers and platforms on Sauce Labs. However, you can also use it locally to debug tests in browsers not available on your machine. It is expected that you are already familiar with Karma when configuring this launcher, so if you are new to Karma, head over to the [Karma website](http://karma-runner.github.io/).
2626

27-
The [Sauce Labs platform configurator](https://wiki.saucelabs.com/display/DOCS/Platform+Configurator/#/) can help to find the correct configuration for your desired test platform.
27+
The [Sauce Labs platform configurator](https://wiki.saucelabs.com/display/DOCS/Platform+Configurator/#/) can help to find the correct configuration for your desired test platform.
2828

2929
### Adding karma-sauce-launcher to an existing Karma config
3030

@@ -91,6 +91,23 @@ module.exports = function(config) {
9191

9292
For example configs using this launcher (using Travis CI), check out this repo's [karma file](https://github.com/karma-runner/karma-sauce-launcher/tree/master/examples/karma.conf-ci.js), the [karma-sauce-example repo](https://github.com/saucelabs/karma-sauce-example) (which demonstrates how to use Sauce locally), or [AngularJS' Karma config](https://github.com/angular/angular.js/blob/master/karma-shared.conf.js).
9393

94+
### Example results in Sauce Labs
95+
Version `4.2.0` and lower of this module will give you the following result in Sauce Labs, no matter how many tests you execute.
96+
97+
![Sauce Logs](/images/saucelabs-old.png)
98+
99+
As of version [4.3.0](https://github.com/karma-runner/karma-sauce-launcher/releases/tag/v4.3.0) the logs are replaced with the
100+
test names and results of the individual tests that have been executed on Sauce Labs, including the execution url in the logs.
101+
102+
**Successful run**
103+
![Sauce Successful Logs](/images/new-sauce-logs-success.png)
104+
105+
**Unsuccessful run**
106+
![Sauce Successful Logs](/images/new-sauce-logs-failure.png)
107+
108+
**Execution url**
109+
![Sauce Successful Logs](/images/sauce-execution-url.png)
110+
94111
## `sauceLabs` config properties shared across all browsers
95112

96113
### username
@@ -124,7 +141,7 @@ Proxy for connecting to Sauce REST API, which is used to communicate job updates
124141
Type: `Boolean`
125142
Default: `true`
126143

127-
If `true`, Sauce Connect will be started automatically.
144+
If `true`, Sauce Connect will be started automatically.
128145
Set this to `false` if you are launching tests locally but want to start Sauce Connect via [a binary](https://wiki.saucelabs.com/display/DOCS/Downloading+Sauce+Connect+Proxy) manually in the background to improve test speed.
129146

130147
### connectOptions
@@ -138,9 +155,9 @@ Default:
138155
}
139156
```
140157

141-
Options to send to Sauce Connect.
158+
Options to send to Sauce Connect.
142159

143-
Check [here](https://wiki.saucelabs.com/display/DOCS/Sauce+Connect+Proxy+Command-Line+Quick+Reference+Guide) for all available options.
160+
Check [here](https://wiki.saucelabs.com/display/DOCS/Sauce+Connect+Proxy+Command-Line+Quick+Reference+Guide) for all available options.
144161
All parameters have to be applied camel cased instead of with hyphens.
145162

146163
### build

0 commit comments

Comments
 (0)