From 07b1deeecf0806e3e56c879c0490f0a297636937 Mon Sep 17 00:00:00 2001 From: Kazuaki Matsuo Date: Sun, 24 Nov 2024 11:45:48 -0800 Subject: [PATCH 1/5] docs: add provisioning profile examples --- docs/preparation/prov-profile-basic-auto.md | 7 ++++++- docs/preparation/prov-profile-generic-manual.md | 11 +++++++---- 2 files changed, 13 insertions(+), 5 deletions(-) diff --git a/docs/preparation/prov-profile-basic-auto.md b/docs/preparation/prov-profile-basic-auto.md index 765139499..35335513a 100644 --- a/docs/preparation/prov-profile-basic-auto.md +++ b/docs/preparation/prov-profile-basic-auto.md @@ -12,7 +12,8 @@ to use the automatic configuration strategy. There are two ways to do this: ```json { "appium:xcodeOrgId": "", - "appium:xcodeSigningId": "Apple Developer" + "appium:xcodeSigningId": "Apple Developer", + "appium:updatedWDABundleId": "" } ``` * Create a `.xcconfig` file somewhere on your file system and add the following to it: @@ -37,6 +38,10 @@ _or_ the combination of `xcodeOrgId` and `xcodeSigningId`. section under the team name. You can also find your Team ID listed under the "Organizational Unit" field in your iPhone Developer certificate in your keychain. * `xcodeSigningId` / `CODE_SIGN_IDENTITY` is usually either `Apple Developer` or `iPhone Developer`. +* `updatedWDABundleId` is the bundle id you would like to use for the built WebDriverAgent. + * Appium replaces the exisitng placeholder of `com.facebook.WebDriverAgentRunner` in `WebDriverAgent.xcodeproj` with the given capability value. + * `xcodebuild` adds `.xctrunner` automatically for XCTest package, thus the provisioning profile you're using should have the suffix, or can be `*`. + * For instance, the `appium:updatedWDABundleId` is `io.appium.WebDriverAgentRunner`, the given provisioning profile should be for `io.appium.WebDriverAgentRunner.xctrunner`, `io.appium.WebDriverAgentRunner.*` or `*`. Once this configuration is done, you should specify your real device UDID with the `udid` desired capability, after which you should be able to start your test. Proceed with diff --git a/docs/preparation/prov-profile-generic-manual.md b/docs/preparation/prov-profile-generic-manual.md index 2574a2438..80dd110d0 100644 --- a/docs/preparation/prov-profile-generic-manual.md +++ b/docs/preparation/prov-profile-generic-manual.md @@ -40,7 +40,10 @@ advanced codesign usage scenarios. !!! note The Appium team distributes generic builds with `CODE_SIGNING_ALLOWED=NO` at - . It is recommended to sign packages with a - wildcard (`*`) provisioning profile, although such profiles require a paid Apple Developer - account. In case of a free account, you may need to update the bundle id before building the - WebDriverAgent package. + [WebDriverAgent package releases](https://github.com/appium/WebDriverAgent/releases). + It is recommended to sign packages with a wildcard (`*`) provisioning profile, + although such profiles require a paid Apple Developer account. + For example, if you're preparing such a provisioning profile for `io.appium.WebDriverAgentRunner.xctrunner`, it will be `io.appium.*`, `io.appium.WebDriverAgentRunner.*` or `*`. + In case of a free account, you may need to update the bundle id before building + the WebDriverAgent package to prepare a properly signed WebDriverAgent package + by `xcodebuild`. From c79b98765a7f3eb8fd8c9beaa7e67727e193e1b3 Mon Sep 17 00:00:00 2001 From: Kazuaki Matsuo Date: Sun, 24 Nov 2024 11:48:42 -0800 Subject: [PATCH 2/5] tweak --- docs/preparation/prov-profile-basic-auto.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/preparation/prov-profile-basic-auto.md b/docs/preparation/prov-profile-basic-auto.md index 35335513a..5d376e9ed 100644 --- a/docs/preparation/prov-profile-basic-auto.md +++ b/docs/preparation/prov-profile-basic-auto.md @@ -40,8 +40,8 @@ _or_ the combination of `xcodeOrgId` and `xcodeSigningId`. * `xcodeSigningId` / `CODE_SIGN_IDENTITY` is usually either `Apple Developer` or `iPhone Developer`. * `updatedWDABundleId` is the bundle id you would like to use for the built WebDriverAgent. * Appium replaces the exisitng placeholder of `com.facebook.WebDriverAgentRunner` in `WebDriverAgent.xcodeproj` with the given capability value. - * `xcodebuild` adds `.xctrunner` automatically for XCTest package, thus the provisioning profile you're using should have the suffix, or can be `*`. - * For instance, the `appium:updatedWDABundleId` is `io.appium.WebDriverAgentRunner`, the given provisioning profile should be for `io.appium.WebDriverAgentRunner.xctrunner`, `io.appium.WebDriverAgentRunner.*` or `*`. + * `xcodebuild` adds `.xctrunner` automatically for XCTest package, thus the provisioning profile you're using should have the suffix explicitly, or it can be for bundle id which has `*`. + * For instance, when the `appium:updatedWDABundleId` is `io.appium.WebDriverAgentRunner`, the given provisioning profile should be for `io.appium.WebDriverAgentRunner.xctrunner`, `io.appium.WebDriverAgentRunner.*` or `*`. Once this configuration is done, you should specify your real device UDID with the `udid` desired capability, after which you should be able to start your test. Proceed with From aecef022074493cba9667632a8dba5b650f3683b Mon Sep 17 00:00:00 2001 From: Kazuaki Matsuo Date: Sun, 24 Nov 2024 11:51:56 -0800 Subject: [PATCH 3/5] fix typo --- docs/preparation/prov-profile-basic-auto.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/preparation/prov-profile-basic-auto.md b/docs/preparation/prov-profile-basic-auto.md index 5d376e9ed..9f1da1548 100644 --- a/docs/preparation/prov-profile-basic-auto.md +++ b/docs/preparation/prov-profile-basic-auto.md @@ -39,8 +39,8 @@ _or_ the combination of `xcodeOrgId` and `xcodeSigningId`. Unit" field in your iPhone Developer certificate in your keychain. * `xcodeSigningId` / `CODE_SIGN_IDENTITY` is usually either `Apple Developer` or `iPhone Developer`. * `updatedWDABundleId` is the bundle id you would like to use for the built WebDriverAgent. - * Appium replaces the exisitng placeholder of `com.facebook.WebDriverAgentRunner` in `WebDriverAgent.xcodeproj` with the given capability value. - * `xcodebuild` adds `.xctrunner` automatically for XCTest package, thus the provisioning profile you're using should have the suffix explicitly, or it can be for bundle id which has `*`. + * Appium replaces the existing placeholder of `com.facebook.WebDriverAgentRunner` in `WebDriverAgent.xcodeproj` with the given capability value. + * `xcodebuild` adds `.xctrunner` automatically for XCTest package. Thus, the provisioning profile you're using should have the suffix explicitly, or it can be for bundle id which has `*`. * For instance, when the `appium:updatedWDABundleId` is `io.appium.WebDriverAgentRunner`, the given provisioning profile should be for `io.appium.WebDriverAgentRunner.xctrunner`, `io.appium.WebDriverAgentRunner.*` or `*`. Once this configuration is done, you should specify your real device UDID with the `udid` desired From 635374ee302c3fd24753a35fea5bb40088391261 Mon Sep 17 00:00:00 2001 From: Kazuaki Matsuo Date: Sun, 24 Nov 2024 11:53:03 -0800 Subject: [PATCH 4/5] tweak --- docs/preparation/prov-profile-generic-manual.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/preparation/prov-profile-generic-manual.md b/docs/preparation/prov-profile-generic-manual.md index 80dd110d0..9a36c85b5 100644 --- a/docs/preparation/prov-profile-generic-manual.md +++ b/docs/preparation/prov-profile-generic-manual.md @@ -43,7 +43,7 @@ advanced codesign usage scenarios. [WebDriverAgent package releases](https://github.com/appium/WebDriverAgent/releases). It is recommended to sign packages with a wildcard (`*`) provisioning profile, although such profiles require a paid Apple Developer account. - For example, if you're preparing such a provisioning profile for `io.appium.WebDriverAgentRunner.xctrunner`, it will be `io.appium.*`, `io.appium.WebDriverAgentRunner.*` or `*`. + For example, if you're preparing such a provisioning profile for `io.appium.WebDriverAgentRunner.xctrunner`, it will be for `io.appium.*`, `io.appium.WebDriverAgentRunner.*` or `*`. In case of a free account, you may need to update the bundle id before building the WebDriverAgent package to prepare a properly signed WebDriverAgent package by `xcodebuild`. From 99d2ef528fa24b683423e78bc8daf563ae8b8ce3 Mon Sep 17 00:00:00 2001 From: Kazuaki Matsuo Date: Mon, 25 Nov 2024 00:12:24 -0800 Subject: [PATCH 5/5] Update prov-profile-basic-auto.md --- docs/preparation/prov-profile-basic-auto.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/preparation/prov-profile-basic-auto.md b/docs/preparation/prov-profile-basic-auto.md index 9f1da1548..1de064b05 100644 --- a/docs/preparation/prov-profile-basic-auto.md +++ b/docs/preparation/prov-profile-basic-auto.md @@ -13,7 +13,7 @@ to use the automatic configuration strategy. There are two ways to do this: { "appium:xcodeOrgId": "", "appium:xcodeSigningId": "Apple Developer", - "appium:updatedWDABundleId": "" + "appium:updatedWDABundleId": "" } ``` * Create a `.xcconfig` file somewhere on your file system and add the following to it: