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

improve prominence of bazel build guidance for iOS targets #546

Merged
merged 2 commits into from
Nov 21, 2024
Merged

improve prominence of bazel build guidance for iOS targets #546

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a57f3ff
improve prominence of bazel build guidance for iOS targets
hborawski Nov 14, 2024
e662b21
Merge branch 'main' into ios-bazel-note
hborawski Nov 15, 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
8 changes: 6 additions & 2 deletions ios/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,12 @@ The demo app can also be built and launched in a simulator from the command line
bazel run //ios/demo:PlayerUIDemo
```

Note:
When building/testing targets with Bazel it is not recommended to build all targets under a package using `/...` because some targets such as those using `swift_library` for example `PlayerUIInternalTestUtilities` and `PlayerUIReferenceAssets` are not buildable due to running on MacOS. It is recommended to build the individual targets and build those that depend on the underlying targets using `swift_library`.

> [!NOTE]
> When building/testing targets with Bazel it is not recommended to build all targets under a package using `/...` as some targets such as those using `swift_library` for example `PlayerUIInternalTestUtilities` and `PlayerUIReferenceAssets` are not buildable due to running on MacOS, or requiring iOS SDKs.

It is recommended to build the individual targets through those that depend on the underlying targets using `swift_library`. In practice, this primarily means build through test targets, or building the example application.

For example, you can't build `PlayerUIInternalTestUtilities` but you can build `//ios/core:PlayerUITests` which builds `PlayerUIInternalTestUtilities` through it being a test dependency.

It is not an issue to use `/...` when [querying](#Examining-Targets) all targets under a package because querying just lists targets and nothing is being built.
Expand Down