Skip to content

Commit

Permalink
updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
DavertMik committed Apr 30, 2019
1 parent c718165 commit f93bd39
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 35 deletions.
13 changes: 7 additions & 6 deletions RoboFile.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,16 +36,17 @@ function publishSite()
*/
function wiki()
{
$res = $this->taskGitStack()
->cloneShallow('[email protected]:Codeception/CodeceptJS.wiki.git', 'website/wiki')
->run();
if (!$res->wasSuccessful()) {
if (!file_exists('website/wiki/Home.md')) {
$this->taskGitStack()
->dir('website/wiki')
->pull()
->cloneShallow('[email protected]:Codeception/CodeceptJS.wiki.git', 'website/wiki')
->run();
}

$this->taskGitStack()
->dir('website/wiki')
->pull()
->run();

$this->taskWriteToFile('docs/community-helpers.md')
->line('---')
->line('id: community-helpers')
Expand Down
3 changes: 2 additions & 1 deletion docs/community-helpers.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,16 @@ Please **add your own** by editing this page.
* [codeceptjs-saucehelper](https://github.com/puneet0191/codeceptjs-saucehelper/) - a helper which updates `Test Names` & `Test Results` on Saucelabs
* [codeceptjs-bshelper](https://github.com/PeterNgTr/codeceptjs-bshelper) - a helper which updates `Test Names` & `Test Results` on Browserstack
* [codeceptjs-tbhelper](https://github.com/testingbot/codeceptjs-tbhelper) - a helper which updates `Test Names` & `Test Results` on TestingBot
* [codeceptjs-applitoolshelper](https://www.npmjs.com/package/codeceptjs-applitoolshelper) - a helper which helps interaction with [Applitools](https://applitools.com)

## Integrations
* [codeceptjs-testrail](https://github.com/PeterNgTr/codeceptjs-testrail) - a plugin to integrate with [Testrail](https://www.gurock.com/testrail)

## Visual-Testing
* [codeceptjs-resemblehelper](https://github.com/puneet0191/codeceptjs-resemblehelper) - a helper which helps with visual testing using resemble.js.
* [codeceptjs-applitoolshelper](https://www.npmjs.com/package/codeceptjs-applitoolshelper) - a helper which helps interaction with [Applitools](https://applitools.com)

## Reporters
* [codeceptjs-rphelper](https://www.npmjs.com/package/codeceptjs-rphelper) is a CodeceptJS helper which can publish tests results on ReportPortal after execution.

## Other

60 changes: 32 additions & 28 deletions lib/helper/WebDriver.js
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,7 @@ const webRoot = 'body';
* ```js
* plugins: {
* wdio: {
* enabled: true,
* services: ['sauce'],
* user: ... ,// saucelabs username
* key: ... // saucelabs api key
Expand Down Expand Up @@ -260,6 +261,7 @@ const webRoot = 'body';
* ```js
* plugins: {
* wdio: {
* enabled: true,
* services: ['browserstack'],
* user: ... ,// browserstack username
* key: ... // browserstack api key
Expand All @@ -272,34 +274,6 @@ const webRoot = 'body';
*
* > Alternatively, use [codeceptjs-bshelper](https://github.com/PeterNgTr/codeceptjs-bshelper) for better reporting.
*
* ### Multiremote Capabilities
*
* This is a work in progress but you can control two browsers at a time right out of the box.
* Individual control is something that is planned for a later version.
*
* Here is the [webdriverio docs](http://webdriver.io/guide/usage/multiremote.html) on the subject
*
* ```js
* {
* "helpers": {
* "WebDriver": {
* "multiremote": {
* "MyChrome": {
* "desiredCapabilities": {
* "browserName": "chrome"
* }
* },
* "MyFirefox": {
* "desiredCapabilities": {
* "browserName": "firefox"
* }
* }
* }
* }
* }
* }
* ```
*
* #### TestingBot
*
* > **Recommended**: use official [TestingBot Helper](https://github.com/testingbot/codeceptjs-tbhelper).
Expand All @@ -317,6 +291,7 @@ const webRoot = 'body';
* ```js
* plugins: {
* wdio: {
* enabled: true,
* services: ['testingbot'],
* user: ... ,// testingbot key
* key: ... // testingbot secret
Expand All @@ -333,6 +308,35 @@ const webRoot = 'body';
*
* > Use [CodeceptJS Applitools Helper](https://github.com/PeterNgTr/codeceptjs-applitoolshelper) with Applitools wdio service.
*
*
* ### Multiremote Capabilities
*
* This is a work in progress but you can control two browsers at a time right out of the box.
* Individual control is something that is planned for a later version.
*
* Here is the [webdriverio docs](http://webdriver.io/guide/usage/multiremote.html) on the subject
*
* ```js
* {
* "helpers": {
* "WebDriver": {
* "multiremote": {
* "MyChrome": {
* "desiredCapabilities": {
* "browserName": "chrome"
* }
* },
* "MyFirefox": {
* "desiredCapabilities": {
* "browserName": "firefox"
* }
* }
* }
* }
* }
* }
* ```
*
* ## Access From Helpers
*
* Receive a WebDriver client from a custom helper by accessing `browser` property:
Expand Down
2 changes: 2 additions & 0 deletions lib/plugin/wdio.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,7 @@ let restartsSession;
* ```js
* plugins: {
* wdio: {
* enabled: true,
* services: ['selenium-standalone']
* // additional config for service can be passed here
* }
Expand All @@ -61,6 +62,7 @@ let restartsSession;
* ```js
* plugins: {
* wdio: {
* enabled: true,
* services: ['sauce'],
* user: ... ,// saucelabs username
* key: ... // saucelabs api key
Expand Down

0 comments on commit f93bd39

Please sign in to comment.