chore(devtools):

- Update website for AutomationProtocols.md, Config and Options.ts with a deprecation warning Contributes to: #11860 Signed-off-by: Georgios Romanas gromanas@gmail.com
webdriverio · Jan 24, 2024 · 7230bbf · 7230bbf
1 parent a6615d3
commit 7230bbf
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 1 deletion.
diff --git a/packages/wdio-types/src/Options.ts b/packages/wdio-types/src/Options.ts
@@ -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.
+     *
+     * :::
      * 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,

diff --git a/website/docs/AutomationProtocols.md b/website/docs/AutomationProtocols.md
@@ -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.
 
 :::
 

diff --git a/website/docs/Configuration.md b/website/docs/Configuration.md
@@ -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`).