feat: upgrade to appium 3

.changeset/upgrade-appium-3.md

@@ -0,0 +1,5 @@
+---
+"appwright": minor
+---
+
+Upgrade to Appium v3.1, update bundled iOS driver support, bump the minimum Node.js runtime to 20.19.0, and let BrowserStack/LambdaTest configs request their Appium server version.

.github/workflows/build.yml

@@ -18,7 +18,7 @@ jobs:
       - name: Setup Node.js environment
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 20.19.0
 
       - name: Install dependencies
         run: npm ci

.github/workflows/package-version.yml

@@ -15,10 +15,10 @@ jobs:
       - name: Checkout Repo
         uses: actions/checkout@v4
 
-      - name: Setup Node.js 20
+      - name: Setup Node.js 20.19
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 20.19.0
 
       - name: Install Dependencies
         run: npm ci

.github/workflows/publish.yml

@@ -16,7 +16,7 @@ jobs:
       - name: Setup Node.js environment
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 20.19.0
 
       - name: Install dependencies
         run: npm ci

.github/workflows/publish_api_reference.yml

@@ -25,7 +25,7 @@ jobs:
         name: Setup Node.js environment
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 20.19.0
 
       - id: "install-dependencies"
         name: "Install Node.js dependencies"

.github/workflows/test.yml

@@ -17,7 +17,7 @@ jobs:
       - name: Setup Node.js environment
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version: 20.19.0
 
       - name: Install dependencies
         run: npm ci

README.md

@@ -32,7 +32,7 @@ Links to help you get started.
 
 ### Minimum requirements
 
-- Node 18.20.4 or higher
+- Node 20.19.0 or higher (Appium 3 requirement)
 
 ### Install
 
@@ -107,6 +107,7 @@ the provider in your config.
       // See supported devices: https://www.browserstack.com/list-of-browsers-and-platforms/app_automate
       name: "Google Pixel 8",
       osVersion: "14.0",
+      appiumVersion: "3.1.0", // Override if your BrowserStack account does not yet support Appium 3
     },
     buildPath: "app-release.apk",
   },
@@ -129,6 +130,7 @@ the provider in your config.
       // See supported devices: https://www.lambdatest.com/list-of-real-devices
       name: "Pixel 8",
       osVersion: "14",
+      appiumVersion: "3.1.0", // Override if your LambdaTest account does not yet support Appium 3
     },
     buildPath: "app-release.apk",
   },

docs/config.md

@@ -24,6 +24,7 @@ These environment variables are required for the BrowserStack
 - BROWSERSTACK_ACCESS_KEY
 
 BrowserStack also requires `name` and `osVersion` of the device to be set in the projects in appwright config file.
+If BrowserStack has not enabled Appium 3 for your account yet, set `appiumVersion` in the device config (or `BROWSERSTACK_APPIUM_VERSION` env var) to request the correct server version.
 
 ### LambdaTest
 
@@ -36,6 +37,7 @@ These environment variables are required for the LambdaTest
 - LAMBDATEST_ACCESS_KEY
 
 LambdaTest also requires `name` and `osVersion` of the device to be set in the projects in appwright config file.
+If LambdaTest has not enabled Appium 3 for your account yet, set `appiumVersion` in the device config (or `LAMBDATEST_APPIUM_VERSION` env var) to request the correct server version.
 
 ### Android Emulator