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.

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

chore(devtools): #12072

Merged
6 changes: 6 additions & 0 deletions packages/wdio-types/src/Options.ts
Original file line number Diff line number Diff line change
Expand Up @@ -270,6 +270,12 @@ export interface WebdriverIO extends Omit<WebDriver, 'capabilities'>, Pick<Hooks
*/
capabilities: RemoteCapability
/**
* :::caution Deprecation Warning
*
* Please note that [`devtools`](https://www.npmjs.com/package/devtools) protocol would be deprecated in future release.
* Please use and would [`webdriver`](https://www.npmjs.com/package/webdriver) protocol instead.
*
* :::
gromanas marked this conversation as resolved.
Show resolved Hide resolved
* Define the protocol you want to use for your browser automation.
* Currently only [`webdriver`](https://www.npmjs.com/package/webdriver) and
* [`devtools`](https://www.npmjs.com/package/devtools) are supported,
Expand Down
2 changes: 1 addition & 1 deletion website/docs/AutomationProtocols.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ There are also plenty of services that allow you to run your automation test in

:::warning Deprecation

WebdriverIO is be deprecating the use of Chrome Devtools as automation protocol through a WebDriver like interface. Instead you can use the [`getPuppeteer`](/docs/api/browser/getPuppeteer) command to get ahold of a Puppeteer instance for Chrome Devtools introspection and automation.
WebdriverIO is deprecating the use of Chrome Devtools as automation protocol through a WebDriver like interface. Instead, you can use the [`getPuppeteer`](/docs/api/browser/getPuppeteer) command to get ahold of a Puppeteer instance for Chrome Devtools introspection and automation.

:::

Expand Down
6 changes: 6 additions & 0 deletions website/docs/Configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,12 @@ The following options (including the ones listed above) can be used with Webdriv

### automationProtocol

:::warning Deprecation

WebdriverIO is deprecating the use of Chrome Devtools as automation protocol through a WebDriver like interface. Instead, you should use [`webdriver`](https://www.npmjs.com/package/webdriver) .

:::

Define the protocol you want to use for your browser automation. Currently only [`webdriver`](https://www.npmjs.com/package/webdriver) and [`devtools`](https://www.npmjs.com/package/devtools) are supported, as these are the main browser automation technologies available.

If you want to automate the browser using `devtools`, make sure you have the NPM package installed (`$ npm install --save-dev devtools`).
Expand Down