Skip to content

Commit

Permalink
docs: add appium:allowProvisioningDeviceRegistration as a hint (#2516)
Browse files Browse the repository at this point in the history
* docs: add appium:allowProvisioningDeviceRegistration as a hint

* fix
  • Loading branch information
KazuCocoa authored Jan 19, 2025
1 parent 18d50d6 commit 08418ed
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions docs/preparation/prov-profile-basic-auto.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,20 +28,21 @@ to use the automatic configuration strategy. There are two ways to do this:
}
```

Note that these are mutually exclusive strategies; use _either_ the `xcodeConfigFile` capability
_or_ the combination of `xcodeOrgId` and `xcodeSigningId`.
Note that these are mutually exclusive strategies; use _either_ the `appium:xcodeConfigFile` capability
_or_ the combination of `appium:xcodeOrgId` and `appium:xcodeSigningId`.

* `xcodeOrgId` / `DEVELOPMENT_TEAM` is a unique 10-character string generated by Apple that is
* `appium:xcodeOrgId` / `DEVELOPMENT_TEAM` is a unique 10-character string generated by Apple that is
assigned to your team.
* To find this string (your Team ID), sign in to [developer.apple.com/account](https://developer.apple.com/account),
and click Membership in the sidebar. Your Team ID appears in the Membership Information
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:xcodeSigningId` / `CODE_SIGN_IDENTITY` is usually either `Apple Developer` or `iPhone Developer`.
* `appium:updatedWDABundleId` is the bundle id you would like to use for the built WebDriverAgent.
* 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 `*`.
* `appium:allowProvisioningDeviceRegistration` lets XCUITest driver set `-allowProvisioningUpdates` and `-allowProvisioningDeviceRegistration` flags for the `xcodebuild` command. They will help register the target device to the matched provisioning profile if it still doesn't have the device. Please check `man xcodebuild` output for more details.

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
Expand Down

0 comments on commit 08418ed

Please sign in to comment.