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.

Sign up for GitHub

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

Jump to bottom

docs: add provisioning profile examples #2496

Merged
merged 5 commits into from
Nov 25, 2024
Merged

docs: add provisioning profile examples #2496

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
07b1dee
docs: add provisioning profile examples
KazuCocoa Nov 24, 2024
c79b987
tweak
KazuCocoa Nov 24, 2024
aecef02
fix typo
KazuCocoa Nov 24, 2024
635374e
tweak
KazuCocoa Nov 24, 2024
99d2ef5
Update prov-profile-basic-auto.md
KazuCocoa Nov 25, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/preparation/prov-profile-basic-auto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@ to use the automatic configuration strategy. There are two ways to do this:
```json
{
"appium:xcodeOrgId": "<Team ID>",
"appium:xcodeSigningId": "Apple Developer"
"appium:xcodeSigningId": "Apple Developer",
"appium:updatedWDABundleId": "<bundle id your provisioning profile can accept>"
}
```
* Create a `.xcconfig` file somewhere on your file system and add the following to it:
Expand All @@ -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 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
capability, after which you should be able to start your test. Proceed with
Expand Down
11 changes: 7 additions & 4 deletions docs/preparation/prov-profile-generic-manual.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,10 @@ advanced codesign usage scenarios.
!!! note

The Appium team distributes generic builds with `CODE_SIGNING_ALLOWED=NO` at
<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. 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 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`.
Loading