Skip to content

Commit

Permalink
Adding Read me Instructions, updating patch
Browse files Browse the repository at this point in the history
  • Loading branch information
puneet0191 committed Dec 21, 2018
1 parent 08f0ad8 commit 9b80fed
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 3 deletions.
22 changes: 22 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,24 @@
# codeceptjs-saucehelper
CodeceptJS Sauce Labs helpers, to update Test Names, Test Results after execution

codeceptjs-saucehelper is [CodeceptJS](https://codecept.io/) helper which is to complete tests results on Sauce Labs after execution. The helper allows to update test name and
test results on sauce labs using the `_passed` and `_failed` hooks accessible in the helper.

NPM package: https://www.npmjs.com/package/codeceptjs-saucehelper

### Configuration

This helper should be added in codecept.json/codecept.conf.js

Example:

```json
{
"helpers": {
"SauceHelper" : {
"require": "codeceptjs-saucehelper"
}
}
}
```
To use the Helper, Users must provide the Sauce User, Sauce Key & Host as part of the configuration.
7 changes: 4 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "codeceptjs-saucehelper",
"version": "1.0.0",
"version": "1.0.2",
"description": "Sauce Labs Result Publisher for Codecept JS tests",
"repository": {
"type": "git",
Expand All @@ -9,8 +9,9 @@
"keywords": [
"codeceptJS",
"codeceptjs",
"saucelabs"
"saucelabs",
"codeceptjs-saucelabs"
],
"author": "Puneet Kala <[email protected]>",
"license": "MIT"
"license": "(ISC OR GPL-3.0)"
}

0 comments on commit 9b80fed

Please sign in to comment.